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.

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

Some links in User's Guide sidebar are broken #2541

Open
samsrabin opened this issue May 13, 2024 · 2 comments
Open

Some links in User's Guide sidebar are broken #2541

samsrabin opened this issue May 13, 2024 · 2 comments
Labels
bfb bit-for-bit bug something is working incorrectly documentation additions or edits to user-facing documentation

Comments

@samsrabin
Copy link
Collaborator

E.g., if in the sidebar you click on 1.5.4 (Running with custom crop calendars), you're taken to https://escomp.github.io/ctsm-docs/versions/master/html/users_guide/running-special-cases/Running-with-custom-crop-calendars.html which gives a 404 error. The actual URL should be https://escomp.github.io/ctsm-docs/versions/master/html/users_guide/running-special-cases/running-with-custom-crop-calendars.html—note lowercase at the front of the HTML filename, even though the .rst file is capitalized.

Note that some capitalized filenames work fine, like https://escomp.github.io/ctsm-docs/versions/master/html/users_guide/adding-new-resolutions/Adding-New-Resolutions-or-New-Files-to-the-build-namelist-Database.html.

There doesn't seem to be a difference in how the filenames are linked in their respective index.rst files: broken, working.

@samsrabin samsrabin added documentation additions or edits to user-facing documentation bug something is working incorrectly bfb bit-for-bit labels May 13, 2024
@samsrabin samsrabin added this to the ctsm6.0.0 (code freeze) milestone May 13, 2024
@samsrabin
Copy link
Collaborator Author

Note that the "Running with irrigation" page has the same issue in the Latest Development Code version of the User's Guide, but not the CLM5.0 version. (I suspect the "Custom crop calendars" page would exhibit this same behavior, but it didn't exist in CLM5.0.)

@samsrabin
Copy link
Collaborator Author

Simplest thing might be to just lowercase all the filenames of pages experiencing this issue. It would be nice to know why this is happening, though...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bfb bit-for-bit bug something is working incorrectly documentation additions or edits to user-facing documentation
Projects
Development

No branches or pull requests

1 participant