Update links to changelogs after moving them #209
Assignees
Labels
bug
Something isn't working
Comments
huonw
added a commit
to pantsbuild/pants
that referenced
this issue
May 21, 2024
This is a fix to paper over the move of release notes in #20847 from `src/python/pants/notes` to `docs/notes`. This is to ensure that links to the old `src/python/pants/notes` locations are not dead, so people land on them and get directed to the right place. These links appear in various blog posts and old doc snapshots (pantsbuild/pantsbuild.org#209) and potentially places that cannot be updated too (e.g. slack, and other people linking them privately). We should still update the ones we can, do the new location, but these stubs provide a fallback for ones that we miss. These were generated by running this script in the `src/python/pants/notes` location: ```shell #!/bin/bash for p in ../../../../docs/notes/*; do filename=$(basename $p) release=$(echo $filename | sed 's/.md//; s/.rst//') if [[ $filename == *.md ]]; then # Markdown: echo -e "# $release Stable releases\n\nThese notes have moved to [\`docs/notes/$filename\`]($p)" else # Restructured text: echo -e "$release Stable releases\n=====================\n\nThese notes have moved to \`docs/notes/$filename <$p>\`_" fi > $filename done # there's a few links to 2.{0,1}.x.rst, but they're now .md echo -e "2.0.x Stable releases\n=====================\n\nThese notes have moved to \`docs/notes/2.0.x.md <../../../../docs/notes/2.0.x.md>\`_" > 2.0.x.rst echo -e "2.1.x Stable releases\n=====================\n\nThese notes have moved to \`docs/notes/2.1.x.md <../../../../docs/notes/2.1.x.md>\`_" > 2.1.x.rst ``` We don't need to adding new ones in future, since future releases won't ever have files in the old place.
This was referenced Jun 9, 2024
huonw
added a commit
that referenced
this issue
Jun 10, 2024
This makes a few changes to the "all versions" page (https://www.pantsbuild.org/versions): - add 2.21 now that we've released it - fix the broken links to documentation: both the extraneous `.x` and pointing to a page that isn't the welcome page (and doesn't exist for some versions). (Fixes #147) - rewrite the changelog links (part of #209)
huonw
added a commit
that referenced
this issue
Jun 10, 2024
This rewrites the old `src/python/pants/notes` path for changelogs to `docs/notes` in three blog posts. Fixes #209 (together with #222) There's still some references to the ``src/python/pants/notes`` path in this repo, but I don't think they need updating. They either: - have a branch or tag reference that has the notes in the old location, e.g. https://github.com/pantsbuild/pantsbuild.org/blob/67038eb6956fe4c8fc956884897efebac6e8fd8d/blog/2023-11-14-pants-2.18.0-is-released/index.mdx#L99 - are in old reference docs, and seems like it can be adequately handled via the redirects we now have: pantsbuild/pants#20937 (alternatively, we _could_ rewrite them)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The changelogs/release notes have moved from
src/python/pants/notestodocs/notes, in pantsbuild/pants#20847. This repo has various references to the old location:git grep src/python/pants/notesfinds 385 matches!We should:
Occurrences in this repo, as computed by:
git grep src/python/pants/notes | cut -f-2 -d/ | sort --version-sort | uniq -c | awk '{ print("|", $2, "|", $1, "|") }'The text was updated successfully, but these errors were encountered: