-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Make CHANGELOG urls clickable #977
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
Merged
mattxwang
merged 2 commits into
just-the-docs:main
from
pdmosses:make-CHANGELOG-urls-clickable
Sep 22, 2022
Merged
Make CHANGELOG urls clickable #977
mattxwang
merged 2 commits into
just-the-docs:main
from
pdmosses:make-CHANGELOG-urls-clickable
Sep 22, 2022
Conversation
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
- Add link reference definitions for PRs and new contributors in v0.4.0.rc2 - Replace inline urls by shortcut link references - Add front matter so the page appears in the navigation - Change the link to the CHANGELOG on the home page The CHANGELOG contents should look the same in the docs and in the repo (apart from the callouts) with clickable links to PRs and some contributors. The urls shown in the changes in v0.4.0.rc1 (and previous releases) haven't yet been made clickable – it would be too tedious and error-prone to do it manually.
- Add a callout
mattxwang
approved these changes
Sep 22, 2022
Member
mattxwang
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for undertaking this work!
mattxwang
pushed a commit
that referenced
this pull request
Sep 22, 2022
* Make CHANGELOG urls clickable - Add link reference definitions for PRs and new contributors in v0.4.0.rc2 - Replace inline urls by shortcut link references - Add front matter so the page appears in the navigation - Change the link to the CHANGELOG on the home page The CHANGELOG contents should look the same in the docs and in the repo (apart from the callouts) with clickable links to PRs and some contributors. The urls shown in the changes in v0.4.0.rc1 (and previous releases) haven't yet been made clickable – it would be too tedious and error-prone to do it manually. * Make CHANGELOG urls clickable - Add a callout
mattxwang
pushed a commit
that referenced
this pull request
Sep 22, 2022
* Make CHANGELOG urls clickable - Add link reference definitions for PRs and new contributors in v0.4.0.rc2 - Replace inline urls by shortcut link references - Add front matter so the page appears in the navigation - Change the link to the CHANGELOG on the home page The CHANGELOG contents should look the same in the docs and in the repo (apart from the callouts) with clickable links to PRs and some contributors. The urls shown in the changes in v0.4.0.rc1 (and previous releases) haven't yet been made clickable – it would be too tedious and error-prone to do it manually. * Make CHANGELOG urls clickable - Add a callout
pdmosses
added a commit
to pdmosses/just-the-docs
that referenced
this pull request
Sep 24, 2022
Extension of PR just-the-docs#977 to v0.4.0.rc1: - Make callouts `loud`. - Replace a warning paragraph by a callout. - Use a reference link instead of an explicit url for @pmarsceill . - Add link reference definitions for PRs and new contributors in v0.4.0.rc1. - Replace inline urls by shortcut link references. The changes to replace URLs by link references would be too tedious and error-prone to do completely manually for v0.4.0.rc1. The following regexp replacements were applied to the sections of v0.4.0.rc1, using Atom: - Copy a section of changes. - In the copy, replace `.*(https://.*pull/)([0-9]+).*$` by `[#$2]: $1$2`. - In the original, replace `(https://.*pull/)([0-9]+)` by `[#$2]`. - Copy a section of new contributors. - In the copy, replace `\* @([^ ]+) .*$` by `[@$1]: https://githhub.com/$1`. - In the original, replace `@([a-zA-Z0-9]+)` by `[@$1]`. Add (co)authors in [just-the-docs#578]: * [@AdityaTiwari2102] made their first contribution in [just-the-docs#477] * [@svrooij] made their first contribution in [just-the-docs#544] [@AdityaTiwari2102]: https://githhub.com/AdityaTiwari2102 [@svrooij]: https://githhub.com/svrooij To test: 1. Check that the CHANGELOG contents looks the same in the docs and in the repo (apart from the callouts) with clickable links to all PRs and contributors for v0.4.0.rc1. 2. Check that none of the lines with changes or new contributors have been removed.
mattxwang
pushed a commit
that referenced
this pull request
Sep 26, 2022
* Make more CHANGELOG urls clickable Extension of PR #977 to v0.4.0.rc1: - Make callouts `loud`. - Replace a warning paragraph by a callout. - Use a reference link instead of an explicit url for @pmarsceill . - Add link reference definitions for PRs and new contributors in v0.4.0.rc1. - Replace inline urls by shortcut link references. The changes to replace URLs by link references would be too tedious and error-prone to do completely manually for v0.4.0.rc1. The following regexp replacements were applied to the sections of v0.4.0.rc1, using Atom: - Copy a section of changes. - In the copy, replace `.*(https://.*pull/)([0-9]+).*$` by `[#$2]: $1$2`. - In the original, replace `(https://.*pull/)([0-9]+)` by `[#$2]`. - Copy a section of new contributors. - In the copy, replace `\* @([^ ]+) .*$` by `[@$1]: https://githhub.com/$1`. - In the original, replace `@([a-zA-Z0-9]+)` by `[@$1]`. Add (co)authors in [#578]: * [@AdityaTiwari2102] made their first contribution in [#477] * [@svrooij] made their first contribution in [#544] [@AdityaTiwari2102]: https://githhub.com/AdityaTiwari2102 [@svrooij]: https://githhub.com/svrooij To test: 1. Check that the CHANGELOG contents looks the same in the docs and in the repo (apart from the callouts) with clickable links to all PRs and contributors for v0.4.0.rc1. 2. Check that none of the lines with changes or new contributors have been removed. * Revert to quiet callouts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The CHANGELOG contents should look the same in the docs and in the repo (apart from the callouts) with clickable links to PRs and some contributors.
The urls shown in the changes in v0.4.0.rc1 (and previous releases) haven't yet been made clickable – it would be too tedious and error-prone to do it manually.