Make more CHANGELOG urls clickable #984
Conversation
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.
|
In view of the many changes in the forthcoming v0.4.0, I think it's important for readers of the theme docs who are migrating from v0.3.3 to see:
(I don't intend to extend this to the changes made in v0.3.3 and earlier, as the entries there are less regular.) |
mattxwang
left a comment
mattxwang
left a comment
There was a problem hiding this comment.
Generally LGTM, really appreciate you putting the effort into this!
Quick question - any specific reason on making the callouts loud? In a side-by-side comparison, I actually find the quiet ones (i.e. what's on the site now) easier to read!
I don't have a particular preference on this. You previously mentioned:
But we're using the light scheme for the theme docs, so making them loud there doesn't address that issue. After v0.4.0, I think we should try to improve callout colours in connection with WCAG. Maybe GitHub Primer has some good suggestions. |
|
Anyway, please feel free to change the config for the theme docs back to |
|
@mattxwang the PR interface is encouraging me to update the branch by merging |
This should always be fine, since we squash merge! It's okay though, I'll handle this merge! |
2 participants
Extension of PR #977 to v0.4.0.rc1:
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.
.*(https://.*pull/)([0-9]+).*$by[#$2]: $1$2.(https://.*pull/)([0-9]+)by[#$2].Copy a section of new contributors.
\* @([^ ]+) .*$by[@$1]: https://githhub.com/$1.@([a-zA-Z0-9]+)by[@$1].Add (co)authors in #578:
grand_parents #477]To test:
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.
Check that none of the lines with changes or new contributors have been removed.