Updating a submitted EMD entry.

The process for submitting a model documentation update through a change request. This guide provides step-by-step instructions for copying existing data and creating a new request in the WCRP-CMIP repository.

CMIP IPO
18 steps
2 minutes

GitHub

Mipcvs

Wcrp-Cmip

Setting up (the pages)

Start by going to the EMD repository:<https://github.com/WCRP-CMIP/Essential-Model-Documentation/tree/src-data>

In a separate window open the modification issue form: <https://github.com/WCRP-CMIP/Essential-Model-Documentation/issues/new?template=modify.yml>

Collecting form information

1. Folder Field

*EMD*: We start by finding the folder containing the information we wish to edit in the EMD. For instance the model / source ids are in the `model` folder.

*From: We then select the same folder from the dropdown menu in the issue.*

2\. Filename Field. This must match exactly otherwise the action will fail.

In navigating to the file in GitHub (by clicking on the folder, then the file we want to change) we get the following page. To ensure the form works we want to copy the file name exactly as it appears and paste it into the form.

We now paste the filename into the form.

3\. Field Name

7\. We now need to decide which fields (`keys`) we wish to change. These are the green bits on the left hand side. of our file. For this example I want to replace the description field. Copy this name.

Change Request

Switch to tab Issues · WCRP-CMIP/Essential-Model-Documentation"

Paste the copied field name into the Field name input

4\. Field Content

Finally we enter what we wish the contents of that field to be changed to exactly. If approved, this will overwrite the previous entry!

5\. Explain why the change is needed.

In order to help reviewers understand why you are making a change, especially in cases where changes may affect multiple people a reason for the request is a must. This will not make it into the file.

Submission

Click "Create"

Pull Request Review

In a couple of minutes the automated action will run updating the issue content (you may need to refresh)

When a pull request is made, this will appear here allowing you to click it and see the proposed changes.

Review Changes

Scrolling down this page, there is a summary for reviewers:

Or you can navigate to the 'Files Changed' tab and see the difference in your selected file:

Here we see the description has been removed and replaced with the value we entered in the form. A reviewer will now look at this and decide to comment, accept or request changes to your submission.

If sucessful, the changes will be merged, and the file you located in step 5 will be updated.