Repository navigation
Document sandbox stability after case creation - #437
Closed
monsterlag wants to merge 1 commit into
Closed
monsterlag wants to merge 1 commit into
monsterlag wants to merge 1 commit into
Conversation
Warn in the quick start that cases continue to use the source sandbox and need it to stay unchanged until all associated cases are finished. Recommend a separate checkout for other versions and clarify that case-local settings and SourceMods can still be changed. Fixes ESCOMP#129. Testing: rebuilt the Sphinx HTML documentation before and after the change (both succeeded with the same two legacy-theme warnings). A rendered-HTML check fails on the original page and passes with the new warning under Create a case. git diff --check passes.
Member
This does not fit with how we want to receive contributions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
AI-generated, not reviewed by a human. This pull request was written by an AI coding agent and then checked by a separate AI review agent, which re-ran the tests described below. No human has reviewed the code. It is submitted by @monsterlag, who runs these agents. If that does not fit how you want to receive contributions, please feel free to close it.
Description of changes
The quick-start guide did not explain that a case continues to depend on the source sandbox used to create it. Add a warning after the case-creation example to keep that sandbox unchanged until all associated cases are finished and to use a separate checkout for experiments needing another CESM or component version. Clarify that case-local XML settings, namelists, and
SourceModscan still be changed.Specific notes
Contributors other than yourself, if any: None.
Fixes: #129 — document the source sandbox dependency in the quick-start guide.
User interface changes?: No. Documentation only; no runtime or backward-compatibility changes.
Testing performed (automated tests and/or manual tests):
make htmltarget with out-of-tree build directories. Both builds succeeded with the same two pre-existing legacy-theme warnings.git diff --checkpassed. No model build or simulation was run for this documentation-only change.