-
Notifications
You must be signed in to change notification settings - Fork 212
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
Add project authors, auto-link GitHub usernames #2066
Conversation
Full-stack documentation: https://docs.openverse.org/_preview/2066 Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again. You can check the GitHub pages deployment action list to see the current status of the deployments. |
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.
LGTM! This is so good. Our custom extensions deserve to be published to PyPI to benefit the Sphinx ecosystem.
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.
I followed the testing instructions and see the notes correctly. If this PR requires more code review, feel free to untag me as a reviewer.
Thanks so much @fcoveram! |
Lol it being open source is scary enough, I don't need that code on PyPI too 😂 😁 |
Description
This PR makes three primary changes:
main
@<username>
to links which reference a user's GitHub profileThe upshot of this is that our documentation site now has reviewers and the original author, and all of the
@
references are linked to the appropriate GitHub user! This helps provide extra context for folks who may be looking at the documents but not the inciting PRs which created said documents.Screenshot
Testing Instructions
Check the preview and see how the new project documents look! Also check some other pages to see that there are no erroneous replacements. Here are some examples:
@swagger...
shouldn't be replaced)@WordPress/maintainers...
shouldn't be replaced)@todo
references here that shouldn't be replaced)@defaultValue
shouldn't be replaced here)@task
should not be replaced here)@playwright
and@types
references shouldn't be replaced)Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin