Skip to content

Migrate Params page to Params Project #31

@DocOtak

Description

@DocOtak

The actual params database got spun off the exchange documentation quite a while ago. Right now, when a new version of the parameters database is published, the version in the requirements document to build the exchange docs needs to be incremented. Even if this was unset, a rebuild of the docs would still need to occur, either manually triggered on readthedocs, or by pushing a change to the repo.

Recently we've also had the blessing from the CCHDO advisory group to "break" with exchange in our CF/netCDF files, meaning that, when the need arises, the exchange files will be a subset of the full dataset inside the CF/netCDF files, further disconnecting the params from the exchange document itself.

I propose that we just move where the params list is to the cchdo/params project and associated documentation. This would make it easier to keep the list up to date with the latest changes. Additional changes, whatever they are deemed to be, could happen after that migration.

In the exchange documentation, a link to the new location would be provided, and links on the CCHDO website itself would need to be updated.

Breaking of directly linking to the downloadable parameters.json file is not a consideration as sphinx randomizes that URL every time the contents change, i.e. this use case is already broken/never worked.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions