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

Add Tutorial to User Guide as Appendix #485

Merged
merged 7 commits into from
Apr 26, 2024

Conversation

apcraig
Copy link
Contributor

@apcraig apcraig commented Apr 26, 2024

PR checklist

  • Short (1 sentence) summary of your PR:
    Add Tutorial to User Guide as Appendix
  • Developer(s):
    apcraig
  • Suggest PR reviewers from list in the column to the right.
  • Please copy the PR test results link or provide a summary of testing completed below.
    No testing done, only documentation changes, reviewed documentation via readthedocs
  • How much do the PR code changes differ from the unmodified code?
    • bit for bit
    • different at roundoff level
    • more substantial
  • Does this PR create or have dependencies on CICE or any other models?
    • Yes
    • No
  • Does this PR add any new test cases?
    • Yes
    • No
  • Is the documentation being updated? ("Documentation" includes information on the wiki or in the .rst files from doc/source/, which are used to create the online technical docs at https://readthedocs.org/projects/cice-consortium-cice/.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please document the changes in detail, including why the changes are made. This will become part of the PR commit log.

Add the tutorial to the user guide as an appendix. Allows for easy links into the rest of the documentation and gives it a permanent and accessible home. The icepack variable name table was also moved to the new appendix section.

Copy link
Contributor

@dabail10 dabail10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@apcraig
Copy link
Contributor Author

apcraig commented Apr 26, 2024

Should the appendices be after or before the references?

@dabail10
Copy link
Contributor

Should the appendices be after or before the references?

I don't really have a preference.

@eclare108213
Copy link
Contributor

These appendices make most sense before the references, in my opinion. This is awesome, thank you very much. I do (as usual) have quite a few little tweaky grammar kinds of things. I'll clone the branch...

@apcraig
Copy link
Contributor Author

apcraig commented Apr 26, 2024

We could also get rid of the formal rst subsections (6.2.1, 6.2.2, etc) and just make those bolded (or similar) headings in the tutorial. That would remove them from the table of contents. I'm not sure they each deserve a separate rst section/heading.

@eclare108213
Copy link
Contributor

I like how visible the subsections are in the text, and I don't mind them showing up in the table of contents.
I'm attempting to edit/commit directly in github. Let me know if you think that's a bad idea... seems like it will work.

@apcraig
Copy link
Contributor Author

apcraig commented Apr 26, 2024

editing and committing in github is fine. individual commits are created just like if you did it in a sandbox.

@apcraig
Copy link
Contributor Author

apcraig commented Apr 26, 2024

Everything looks good to me. Any other comments/changes?

Copy link
Contributor

@eclare108213 eclare108213 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thank you!

@eclare108213 eclare108213 merged commit 74cc6f4 into CICE-Consortium:main Apr 26, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants