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

Add project authors, auto-link GitHub usernames #2066

Merged
merged 5 commits into from
May 10, 2023

Conversation

AetherUnbound
Copy link
Collaborator

@AetherUnbound AetherUnbound commented May 9, 2023

Description

This PR makes three primary changes:

  • Adds a field for the author in the project proposal and implementation plan templates
  • Backfills author information for all existing project proposals that are present in main
  • Adds a very simple and naive extension to Sphinx which converts specific instances of @<username> to links which reference a user's GitHub profile

The 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

image

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:

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@AetherUnbound AetherUnbound added 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 📄 aspect: text Concerns the textual material in the repository 🧱 stack: documentation Related to Sphinx documentation labels May 9, 2023
@AetherUnbound AetherUnbound requested a review from a team as a code owner May 9, 2023 22:05
@github-actions
Copy link

github-actions bot commented May 9, 2023

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.

Copy link
Member

@dhruvkb dhruvkb left a 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.

Copy link
Contributor

@fcoveram fcoveram left a 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.

@AetherUnbound
Copy link
Collaborator Author

Thanks so much @fcoveram!

@AetherUnbound
Copy link
Collaborator Author

LGTM! This is so good. Our custom extensions deserve to be published to PyPI to benefit the Sphinx ecosystem.

Lol it being open source is scary enough, I don't need that code on PyPI too 😂 😁

@AetherUnbound AetherUnbound merged commit e5659ba into main May 10, 2023
@AetherUnbound AetherUnbound deleted the feature/plan-authors branch May 10, 2023 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants