Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature 874 doc #1114

Closed
wants to merge 5 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 37 additions & 2 deletions docs/Contributors_Guide/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,47 @@ Contributor's Guide:
Release Guide:
~~~~~~~~~~~~~~

Coming soon!
* To add/modify the instructions for creating software releases for
any METplus component, including official, bugfix, and development
releases.

* Each METplus component has a top level file (e.g. metplus.rst)
which simply contains references to files for each of the
releases. For example, metplus.rst contains references to:

* metplus_official
* metplus_bugfix
* metplus_development

* Each release file (e.g. metplus_official.rst, metplus_bugfix.rst,
metplus_development.rst) contains, at a minimum, a replacement
value for the projectRepo variable and include
statements for each release step. These individual steps
(e.g. open_release_issue.rst, clone_project_repository.rst, etc.)
may be common to multiple METplus components. These common steps
are located in the *release_steps* directory. However, a METplus
component may have different instructions from other componenets
(e.g. For METplus wrappers, update_version.rst,
create_release_extra.rst, etc.). In this case, the instructions
that are specific to that component are located in a subdirectory
of *release_steps*. For example, files that are specific to
METplus wrappers are located in *release_steps/metplus*, files
that are specific to METcalcpy are located in
*release_steps/metcalcpy*.

* The file for each individual step (e.g. open_release_issue.rst,
update_version.rst, etc.) contains the instructions for
completing that step for the release.


Verification Datasets Guide:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Coming soon!
* To add/modify any relevant datasets in attempt to create a
centralized catalogue of verification datasets to provide the model
verification community with relevant "truth" datasets. See the
`Verification Datasets Guide Overview <https://metplus.readthedocs.io/en/latest/Verification_Datasets/overview.html>`_
for more information.

.. _read-the-docs:

Expand Down