Skip to content

Commit ff915aa

Browse files
committed
Update Pages links to use /CTSM instead of /ctsm.
1 parent 70af927 commit ff915aa

File tree

6 files changed

+8
-6
lines changed

6 files changed

+8
-6
lines changed

.github/ISSUE_TEMPLATE/03_documentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ about: Something should be added to or fixed in the documentation
1212
- [ ] Something is broken.
1313

1414
### What part(s) of the documentation does this concern?
15-
- [ ] [Technical Note](https://escomp.github.io/ctsm/tech_note/index.html) (science and design of the model)
16-
- [ ] [User's Guide](https://escomp.github.io/ctsm/users_guide/index.html) (using the model and related tools)
15+
- [ ] [Technical Note](https://escomp.github.io/CTSM/tech_note/index.html) (science and design of the model)
16+
- [ ] [User's Guide](https://escomp.github.io/CTSM/users_guide/index.html) (using the model and related tools)
1717
- [ ] Somewhere else (e.g., README file, tool help text, or code comment): _Please specify_
1818
- [ ] I don't know
1919

.github/workflows/docs-build-and-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
run: |
5252
bin/git-fleximod update -o
5353
cd doc
54-
./build_docs_to_publish -d --container-cli-tool docker --site-root https://escomp.github.io/ctsm
54+
./build_docs_to_publish -d --container-cli-tool docker --site-root https://escomp.github.io/CTSM
5555
5656
- name: Upload artifact
5757
uses: actions/upload-pages-artifact@v3

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ http://www.cesm.ucar.edu/models/cesm2.0/land/
1515

1616
and
1717

18-
https://escomp.github.io/ctsm/
18+
https://escomp.github.io/CTSM/
1919

2020
For help with how to work with CTSM in git, see
2121

doc/source/tech_note/Introduction/CLM50_Tech_Note_Introduction.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,8 @@ Introduction
152152

153153
The purpose of this document is to fully describe the biogeophysical and biogeochemical parameterizations and numerical implementation of version 5.0 of the Community Land Model (CLM5.0). Scientific justification and evaluation of these parameterizations can be found in the referenced scientific papers (:ref:`rst_References`). This document and the CLM5.0 User's Guide together provide the user with the scientific description and operating instructions for CLM.
154154

155+
.. _model-history:
156+
155157
Model History
156158
---------------
157159

doc/source/users_guide/overview/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Developers that are making changes to CLM either for their own development or fo
3333
What is New with |version|
3434
============================
3535

36-
`What's new with |version| science <https://escomp.github.io/ctsm/doc/build/html/tech_note/Introduction/CLM50_Tech_Note_Introduction.html#|version|/>`_ gives a synopsis of the changes to CLM since the CLM4.5 release. More details are given in the CLM ChangeLog files:
36+
The :ref:`model history section <model-history>` section gives a synopsis of the changes to CLM in each release. More details are given in the CLM ChangeLog files:
3737

3838
- `CLM 3.0 ChangeLog file <https://github.com/ESCOMP/CTSM/blob/master/doc/clm3_0_ChangeLog>`_
3939
- `CLM 4.0 ChangeLog file <https://github.com/ESCOMP/CTSM/blob/master/doc/clm4_0_ChangeLog>`_

doc/source/users_guide/working-with-documentation/building-docs-multiple-versions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ How this works
2424

2525
For each member of `VERSION_LIST`, ``build_docs_to_publish`` checks out its `ref`, then builds the documentation in a build directory. (`LATEST_REF` is set because some files, folders, and submodules are important for how the build works and need to stay the same for each build.) Once the build is complete, ``build_docs_to_publish`` should reset your local repo copy (CTSM clone) to how it was before you called ``build_docs_to_publish``.
2626

27-
Next, ``build_docs_to_publish`` moves the HTML files from the build directory to the publish directory. The publish directory has a structure that matches the paths in the version dropdown menu's links. If a member of ``VERSION_LIST`` has ``landing_version=True``, its HTML will be at the top level. That makes it simple for people to find the default version of the docs at https://escomp.github.io/ctsm, rather than having to drill down further into something like ``https://escomp.github.io/ctsm/versions/latest``.
27+
Next, ``build_docs_to_publish`` moves the HTML files from the build directory to the publish directory. The publish directory has a structure that matches the paths in the version dropdown menu's links. If a member of ``VERSION_LIST`` has ``landing_version=True``, its HTML will be at the top level. That makes it simple for people to find the default version of the docs at https://escomp.github.io/CTSM, rather than having to drill down further into something like ``https://escomp.github.io/CTSM/versions/latest``.

0 commit comments

Comments
 (0)