Skip to content

[Doc]: PyData NYC Tagging Sprint #27235

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

Open
esibinga opened this issue Oct 31, 2023 · 2 comments
Open

[Doc]: PyData NYC Tagging Sprint #27235

esibinga opened this issue Oct 31, 2023 · 2 comments
Labels
Documentation: tags tagging examples + proposing new tags Documentation mentored: sprint Issues intended and suitable for sprints

Comments

@esibinga
Copy link
Collaborator

esibinga commented Oct 31, 2023

The following issue is restricted to folks participating in-person at the PyData New York Sprints on Oct 31st. Eventually we plan to open participation to everyone, but are starting with a small group to work out how to scale this in a managable way.

Introduction

We're improving the user experience of Matplotlib's gallery of examples by implementing tags for better organization and navigability. Over the last few months, we developed tagging guidelines and began to tag some examples. Now we're ready to see what we can do with more brains on the project.

Participants

Hey folks, thanks for helping us tag our gallery. This sprint has two stages:

  • NO CODE: Tag gallery examples in our tagging spreadsheet
  • LOW CODE (optional): Add tags to gallery examples using the tag directive

To participate, please:

Tag examples

Add tags to the spreadsheet following these instructions:

To add a single tag:

  1. Add your Github handle to Column K
  2. Type the tag you want to add in Column G

To add multiple tags (manual method)

  1. Add your Github Handle to Column K
  2. You can type the tags in manually, just make sure to double check that the formatting is correct. Each tag is in the format subcategory: tag, and multiple tags must be separated by commas.

Convert tags to pull request (optional)

Please only open pull requests for entries you have tagged, unless you have gotten permission from the person who tagged those entries.

  1. Create a fork and development environment as described in our pull request guide
  2. Add tags as described in our tagging guide
  3. Follow the rest of the instructions in the pull request guide to create a pull request
    • If you're working on an entry tagged by someone else, add them as a co-author
  4. Add a link to the PR to the spreadsheet entry

Propose a new tag

During the tagging sprint, you can propose new tags by adding them to the propose new tags sheet in the spreadsheet. After the tagging sprint, new tag proposals will new issues. Check the propose new tags sheet for instructions and a place for proposed tags.

Maintainers

Hey folks, thanks for your help! Please add tagging pull requests to the Gallery Tagging Project and milestone for 3.9.0.

If the pull request needs extra attention, please tag @esibinga, @melissawm or @story645

@story645 story645 added Documentation: tags tagging examples + proposing new tags mentored: sprint Issues intended and suitable for sprints labels Oct 31, 2023
@story645 story645 added this to the v3.9.0 milestone Oct 31, 2023
@ShivamPathak99
Copy link
Contributor

Are there any more examples to tagging ?

@story645
Copy link
Member

Are there any more examples to tagging ?

Yeah, anything in the gallery can be tagged and anything that has tags can have more added to them. We just haven't been merging tags yet b/c waiting on a sphinx-tags update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: tags tagging examples + proposing new tags Documentation mentored: sprint Issues intended and suitable for sprints
Projects
None yet
Development

No branches or pull requests

4 participants