You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Proposed change: serve the data docs at https://docs.e3sm.org/data/
The main site is built with MkDocs, which copies non-Markdown files from docs/ into the built site unchanged. So a small HTML redirect stub is enough. No renaming or new tooling is needed.
Steps
Create docs/data/index.html in E3SM-Project.github.io with the following content:
<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><title>E3SM Data Docs</title><linkrel="canonical" href="https://docs.e3sm.org/e3sm_data_docs/_build/html/index.html"><metahttp-equiv="refresh" content="0; url=https://docs.e3sm.org/e3sm_data_docs/_build/html/index.html"></head><body><p>Redirecting to the
<ahref="https://docs.e3sm.org/e3sm_data_docs/_build/html/index.html">E3SM Data Docs</a>…
</p></body></html>
The target is absolute so it doesn't depend on relative path resolution. The canonical link tells search engines which URL is the real one, and the body link covers browsers that block meta refresh.
Update the link in docs/index.md:
-- [Data](https://e3sm-project.github.io/e3sm_data_docs/_build/html/index.html) - Output from major E3SM simulations+- [Data](https://docs.e3sm.org/data/) - Output from major E3SM simulations
The trailing slash avoids a GitHub Pages redirect hop from /data to /data/. https://docs.e3sm.org/data will still work for anyone who types it without the slash.
Check for conflicts before merging:
There is no docs/data/index.md or docs/data.md (MkDocs would try to build a page at the same path).
mkdocs.yml doesn't list data/ under exclude_docs (or a similar setting, depending on the MkDocs version).
Deploy and test: after the site rebuilds, open https://docs.e3sm.org/data/ in a private window and confirm it lands on the data docs. Also click the Data link on https://docs.e3sm.org/.
Notes
After the redirect, the address bar will show the long .../e3sm_data_docs/_build/html/index.html URL. Only the entry-point link and anything bookmarked or shared from docs.e3sm.org will use the short /data/ form.
Alternative: if the project already uses (or is willing to add) the mkdocs-redirects plugin, step 1 can be replaced with this in mkdocs.yml:
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
documentationImprovements or additions to documentation
2 participants
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.
Renata had the following suggestions for changing the DataDocs link:
/data