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.

Sign up for GitHub

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

Jump to bottom

doc: improve "Quick Start" section #765

Merged
merged 1 commit into from
Oct 6, 2022
Merged

doc: improve "Quick Start" section #765

merged 1 commit into from
Oct 6, 2022

Conversation

phil-blain
Copy link
Member

PR checklist

  • Short (1 sentence) summary of your PR:
    title
  • Developer(s):
    me
  • 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 tests needed.
  • 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 Icepack or any other models?
    • Yes
    • No
  • Does this PR update the Icepack submodule? If so, the Icepack submodule must point to a hash on Icepack's main branch.
    • 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/. A test build of the technical docs will be performed as part of the PR testing.)
    • Yes
    • No, does the documentation need to be updated at a later time?
      • Yes
      • No
  • Please provide any additional information or relevant details below:

These are some improvements to the quick start section after comments by @dupontf when he followed the instructions to use CICE6.

  • mention cloning with --recurse-submodules
  • fix the link to the Git Workflow Guide.
  • improve the wording a bit

@phil-blain
doc: improve "Quick Start" section
9529b03 
Mention that CICE must be cloned with '--recurse-submodules' for Icepack
to also be cloned, formatting the 'git clone' command as a code block,
and fix the link to the Git Workflow Guide.
eclare108213
eclare108213 reviewed Oct 6, 2022
View reviewed 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.

It's good to be accurate and consistent -- thanks for these changes..
In the git workflow guide, I believe we recommend using --recursive instead of --recurse-submodules.

@phil-blain
Copy link
Member Author

phil-blain commented Oct 6, 2022 •
edited
Loading

Yeah, --recursive is semi-deprecated, --recurse-submodules is more recent and more in line with the rest of the Git commands (which all use --recurse-submodules). They do the exact same thing.

@eclare108213
Copy link
Contributor

Okay, then maybe we should update the git workflow doc too.

@apcraig
Copy link
Contributor

apcraig commented Oct 6, 2022

I updated the git workflow document. Will merge this now.

@apcraig apcraig merged commit 422117f into CICE-Consortium:main Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eclare108213 eclare108213 eclare108213 left review comments

@apcraig apcraig apcraig approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@phil-blain @eclare108213 @apcraig