Skip to content

Conversation

@samsrabin
Copy link
Member

@samsrabin samsrabin commented May 23, 2025

Description of changes

  • Enables automatic publication of documentation to this repo's GitHub Pages, making ctsm-docs repo obsolete.
  • Updates documentation documentation.

Specific notes

Contributors other than yourself, if any: None

CTSM Issues Fixed:

Are answers expected to change (and if so in what way)? No

Any User Interface Changes (namelist or namelist defaults changes)? Not to the model, no.

Does this create a need to change or add documentation? Did you do so? Yes; yes.

Testing performed, if any: See checks.

Remaining work

  • Update documentation about building multiple versions
  • Replace all references to ctsm-docs repo
  • Add all include::ed files as triggers for docs workflows
  • build-docs-omnibus-test is expected to fail until versions_list.py is updated to point to clm5.0 release branch

Waiting on b4b-dev merge

  • Merge in latest master tag
  • Point this PR at master instead of b4b-dev

After merging

samsrabin added 2 commits May 23, 2025 01:49
# Conflicts:
#	.github/workflows/docker-image-build-publish.yml
#	.github/workflows/docker-image-build.yml
#	.github/workflows/docker-image-common.yml
#	.github/workflows/docs-ctsm_pylib.yml
#	.github/workflows/docs.yml
#	.gitignore
#	.gitmodules
#	doc/ChangeLog
#	doc/ChangeSum
#	doc/ctsm-docs_container/README.md
#	doc/source/conf.py
#	doc/source/users_guide/working-with-documentation/building-docs-original-wiki.md
#	doc/source/users_guide/working-with-documentation/docs-intro-and-recommended.md
#	doc/source/users_guide/working-with-documentation/index.rst
@samsrabin samsrabin self-assigned this May 23, 2025
@samsrabin samsrabin added the documentation additions or edits to user-facing documentation or its infrastructure label May 23, 2025
@samsrabin samsrabin added the devops Development Operations to improve development throughput, E.g., adding GitHub Workflows label May 23, 2025
@samsrabin samsrabin changed the base branch from master to b4b-dev May 23, 2025 08:05
@samsrabin samsrabin changed the base branch from b4b-dev to master May 23, 2025 08:07
# Conflicts:
#	.github/workflows/docker-image-build.yml
#	.github/workflows/docker-image-common.yml
#	.github/workflows/docs-ctsm_pylib.yml
#	.github/workflows/docs.yml
#	.github/workflows/fleximod_test.yaml
#	.github/workflows/formatting_python.yml
#	doc/source/conf.py
@samsrabin samsrabin changed the title [WIP] Automatically publish docs to this repo Automatically publish docs to this repo May 23, 2025
@samsrabin samsrabin added the blocked: dependency Wait to work on this until dependency is resolved label May 23, 2025
@samsrabin samsrabin marked this pull request as ready for review May 23, 2025 18:34
@samsrabin samsrabin changed the base branch from master to b4b-dev May 23, 2025 19:25
@samsrabin samsrabin removed the blocked: dependency Wait to work on this until dependency is resolved label May 23, 2025
@samsrabin samsrabin requested a review from ekluzek May 23, 2025 20:27
Copy link
Collaborator

@ekluzek ekluzek left a comment

Choose a reason for hiding this comment

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

@samsrabin and I went over this. And this looks great. We talked about a few things to do. But, approving so he doesn't have to wait for me.

This also will be rebased to deploy on master rather than b4b-dev. There are extra diffs shown here because there are changes from master that show up here. But, that will go away, once b4b-dev goes to master, and this is rebased to master.

@samsrabin samsrabin added the blocker another issue/PR depends on this one label May 24, 2025
@samsrabin samsrabin changed the title Automatically publish docs to this repo ctsm5.3.048: Automatically publish docs to this repo May 27, 2025
@github-project-automation github-project-automation bot moved this to Ready to start (or start again) in CTSM: Upcoming tags May 27, 2025
@samsrabin samsrabin moved this from Ready to start (or start again) to In progress - master in CTSM: Upcoming tags May 27, 2025
@samsrabin samsrabin changed the base branch from b4b-dev to master May 27, 2025 00:26
@samsrabin samsrabin merged commit a2782b4 into ESCOMP:master May 27, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from In progress - master to Done (non release/external) in CTSM: Upcoming tags May 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocker another issue/PR depends on this one devops Development Operations to improve development throughput, E.g., adding GitHub Workflows documentation additions or edits to user-facing documentation or its infrastructure

Projects

Status: Done
Status: Done (non release/external)
Status: No status

Development

Successfully merging this pull request may close these issues.

Fix capital letter in doc filenames Automatically publish updated docs Some links in User's Guide sidebar are broken

2 participants