-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Establish draft Tag glossary and Tagging guidelines #26851
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
Conversation
Totally forgot to mention it but I've wanted a "version:x.y.z" tag for a while so we could flag and filter on when specific features came in. |
Moved to draft for now - this isn't included in a TOC, so breaks the doc build. |
I think a Not clear if
Is there another word for aesthetic? I think I will learn to spell it, but I guess I'm not the only one that will get it wrong a few times... (Not that I object the word as such... But "styling"?) |
I think it's a really solid proposal! Thank you Eva for doing this work! My thoughts:
|
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.
Hi @esibinga - this is an initial formatting/Sphinx-conforming review for us to get the preview working, and I confirmed that this should solve any remaining docs building issues. I think there are also other formatting considerations for later but at least we'll be able to see the rendered page after these fixes 😄
@paniterka So many good points, thank you! This is a long response, but I found it helpful to type up my thoughts so may as well make the discussion public. re:
re:
re:
re:
|
Oh there is one action left for the docs build to work: you need to rebase/merge the main branch into yours, because of the switch to meson builds. So here are the steps you need to take:
After this, push back into this branch with |
b74c4a6
to
8644770
Compare
0819012
to
ad4dee2
Compare
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
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.
Hi @esibinga - I have a few cosmetic changes that have the goal of organizing the content and making it easier for folks to skim and find the section they are looking for. All of these are suggestions, so feel free to take or leave any of them. If you feel like reorganizing the level of section/subsection differently that is also up to you! Cheers 😄
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
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.
This is looking really solid! Slight concern that the propose new tags section is a bit thin on process but otherwise comments are I hope/intend mostly minor requests for some fleshing out.
Co-authored-by: hannah <story645@gmail.com>
So summary on what we've discussed as process for proposing new tags. The rational for doing this as an issue first then PR is so maintainers don't try to review a PR adding tags w/o there first being consensus on the tags.
@esibinga suggested this be a (possibly informal) template and I very much encourage/support codifying the tag proposal procedure as an issue template to help streamline proposal/discussion. |
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
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.
Not blocking, more little suggestions mostly.
------------------ | ||
|
||
1. Review existing tag list, looking out for similar entries (i.e. ``axes`` and ``axis``). | ||
2. If a relevant tag or subcategory does not yet exist, propose it. Each tag is two parts: ``subcategory: tag``. Tags should be one or two words. |
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.
add the "how to propose" process list?
Co-authored-by: hannah <story645@gmail.com>
+-------------------------------+-----------------------------------------------------------------------+ | ||
|``tag`` | use case | | ||
+===============================+=======================================================================+ | ||
|``internal: low bandwidth`` |allows users to filter out bandwidth-intensive examples like animations| |
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.
If that is the intent then should we tag the minority (high bandwith) examples instead?
+===============================+=======================================================================+ | ||
|``internal: low bandwidth`` |allows users to filter out bandwidth-intensive examples like animations| | ||
+-------------------------------+-----------------------------------------------------------------------+ | ||
|``internal: untagged`` |allows docs contributors to easily find untagged examples | |
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.
wouldn't it be easier to search for files that do not have the tag directive?
|
||
How to tag? | ||
----------- | ||
Put each tag as a directive at the bottom of the page. |
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.
include an example in this text?
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.
small comments 👍🏻 on merging as-is.
We'll do follow ups later today |
GSOD: example gallery tagging project
I would like feedback on:
I plan to make these additions:
cc: @story645 @melissawm