Updating a few documentation issues#364
Conversation
|
@apcraig @phil-blain |
|
Looks good Alice @duvivier. I modified the section "Push changes back to the repo" to be more in line with the fact that build happens automatically now. One minor point : you mention that the user can use different branches for the doc and code modifications ; I think it makes more sense to do both in the same branch, so I think that is what we should recommend in the documentation workflow. |
|
@phil-blain Agreed. I just went through and modified that bit as well. I think it's pretty good to go at this point. |
For detailed information about submitting Pull Requests (PRs) to the CICE-Consortium,
please refer to: https://github.com/CICE-Consortium/About-Us/wiki/Resource-Index#information-for-developers
PR checklist
Modifying documentation with changes to RTD integration.
Alice DuVivier
N/A
With the integration of RTD auto builds as part of a PR, we need to update some documentation.
Most of the documentation will need to be updated on the Wiki instead of code. We shouldn't close this until I've also updated things there:
https://github.com/CICE-Consortium/About-Us/wiki/Documentation-Workflow-Guidance
I also found that the COREII forcing data should be cited and added that.