Conversation
slevis-lmwg
added
documentation
github-project-automation
bot
moved this to Ready to start (or start again)
in CTSM: Upcoming tags
slevis-lmwg
moved this from Ready to start (or start again)
to In progress - b4b-dev
in CTSM: Upcoming tags
See if this renders better.
|
Note to self: Look for more READMEs that need conversion. @ekluzek how should we handle the presence of both a README and a README.md in the /ctsm directory? |
slevis-lmwg
modified the milestones:
cesm3.0.0 release branch tag,
ctsm6.0.0 (code freeze)
Good question. The README.md shows up as what you see on github. And it's probably something we want to be short, with the main content being what we want people to see when they got to CTSM on github. In contrast, the content of the README details about how to use CTSM and some practical details about how to get around in the checkout. So you could add the content of the plain README to the README.md, but make it at the end. The other option would be to have a file with a different name maybe something like: README_on_CTSM.md? Which sounds better to you? |
|
@samsrabin I will send you a review request:
|
samsrabin
left a comment
samsrabin
left a comment
There was a problem hiding this comment.
Great start, Sam, thanks! I've requested some changes and added other comments.
| bin/git-fleximod -- Script to manage the needed sub-component source directories (handled with git submodule) | ||
| py_env_create ----- Script to setup the python environment for CTSM python tools using conda | ||
| python ------------ Python modules used in tools and testing and automated checking of ALL CTSM python scripts | ||
| doc --------------- Documentation of CTSM |
There was a problem hiding this comment.
Why the deleted periods and added whitespace here and elsewhere?
There was a problem hiding this comment.
These separate lines (and others elsewhere) were wrapping into single continuous lines. I asked AI for a simple solution and got the suggestion of two spaces at the end of each line, which worked.
There was a problem hiding this comment.
@samsrabin if you are ok with my response directly above, then please
- go ahead and resolve this conversation and
- let me know if you have further comments/concerns with this PR and if not
- approve
Thanks!
github-project-automation
bot
moved this from In progress - b4b-dev
to Stalled (needs review, blocked etc.)
in CTSM: Upcoming tags
Replaced same file previously but ended up with strange artifacts. Testing now with pandoc, as suggesed in Sam R.'s code review.
slevis-lmwg
moved this from Stalled (needs review, blocked etc.)
to In progress - b4b-dev
in CTSM: Upcoming tags
|
SORRY the last commit was a mistake, and I will revert it. |
3 participants
Description of changes
See title
Specific notes
Contributors other than yourself, if any:
CTSM Issues Fixed (include github issue #):
Fixes #2761
Are answers expected to change (and if so in what way)?
No
Any User Interface Changes (namelist or namelist defaults changes)?
No
Does this create a need to change or add documentation? Did you do so?
No
Testing performed, if any:
None needed