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

WIP: Make PR numbers into links in release notes #128

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

melissawm
Copy link
Member

Description

This is a first attempt at a "linkifyer" (still needs extra functionality for style and for PRs in other repos)

Type of change

  • Fixes or improves existing content
  • Adds new content page(s)
  • Fixes or improves workflow, documentation build or deployment

References

closes #169

Final checklist:

  • My PR is the minimum possible work for the desired functionality
  • I have commented my code, particularly in hard-to-understand areas
  • I have added alt text to new images included in this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 29, 2023
@melissawm melissawm changed the title IIP: Make PR numbers into links in release notes WIP: Make PR numbers into links in release notes Mar 29, 2023
@melissawm
Copy link
Member Author

I am not sure that this is worth the effort. It seems that for more recent release notes the links have been added consistently so do we still need to do this? Maybe the best option would be to just manually apply it once to older release notes so that all of them have links instead of overengineering 😄

@jni
Copy link
Member

jni commented Aug 15, 2024

Oh, interesting, I hadn't looked at this yet and I assumed it was indeed a onetime thing.

Personally, I kinda like the idea of linkifying all the docs — it makes writing the markdown easier. But I don't know how this interacts with already-linked references...?

Anyway, I agree that it's not as important as it used to be, because our release scripts are doing this automatically now.

Note, some earlier release notes (at least 0.4.18), some of the links were napari/napari/#9301 (note the extra /) — it would be good as part of this effort to harmonise them to just #num.

None of this is urgent, though — I'd say it's fine to keep it on the backburner.

@psobolewskiPhD
Copy link
Member

Looks like https://napari.org/stable/release/release_0_4_17.html and older doesn't have links, while all the more recent ones do, which is probably all that anyone cares about? 🤷

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

PR # on release notes should be links
3 participants