Closed (fixed)
Project:
Documentation
Component:
Other documentation issues
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
3 Jul 2011 at 03:52 UTC
Updated:
18 Jul 2011 at 19:02 UTC
Although the tags system is something of a free-for-all, there are certain core issue tags that have specific, generally-agreed-upon meanings.
I have started documenting some of them at Standard Issue Tags for Drupal core and would appreciate feedback and/or correction.
Comments
Comment #1
pillarsdotnet commentedComment #2
dddave commentedGreat write-up.
Do we need a consistent policy about capitalization? At the moment sometimes we have "needs..." or "Needs..." and "Performance" but "accessibility".
Comment #3
pillarsdotnet commentedDunno. I documented what is, not what should be. I don't have the ability to change the capitalization of the existing tags.
Comment #4
sunThis looks done to me. Further tags may naturally be added over time.
Thanks for the kick-starting it!
Comment #5
pillarsdotnet commentedChanged the urls back to lowercase and moved each definition to a single line for easier alphabetical sorting.
Comment #6
pillarsdotnet commentedHere are the top 100 tags as provided by Damien Tournoud in #1207026: Please give a list of all tags:
Comment #7
pillarsdotnet commentedComment #8
sunugh. It definitely does not make sense to document topical tags.
The tags that were on the page previously are all "meta" tags or have structural/organizational meaning.
Tags like jQuery, JavaScript, CSS, DrupalWTF, PHP 5.3, PostgreSQL, Token, Libraries, or Views are pure categorization into topics where applicable and do not have any special meaning. We should not document them.
Out of those that have been added to the page now, only the following may be considered:
- Coding Standards: Implies that community-wide consensus is required for the issue to be fixed. More consensus than for other issues.
- [D7] Upgrade path: Debatable. There's no special workflow bound to these. The "official" tag merely helps to get an impression of what's still not working. Normally, the tag should be simply "Upgrade path" + appropriately assigned version. Should ideally be renamed administratively.
Comment #9
pillarsdotnet commentedThere are at least five tags dealing with PHP 5.3 and I think we should standardize on one of them.
Comment #10
sunThere are also multiple and duplicate tags for other topics. But that does not mean that they are in any way official or have any special meaning.
By including tags in this list that do not have any special meaning, that page will quickly and infinitely grow to something that's a) no longer useful, b) unmaintainable, and c) anything but official.
The tags that have been added now vaporize the originally clean and mean list of special issue tags, since they provide irrelevant information in between highly interesting information.
Standardizing on one tag among duplicates is a completely different task and goal. It's an ongoing and never-ending site moderation job. Normally, one would install and use a module that adds synonym collapsing functionality to Taxonomy module (last time I checked there were multiple modules for this), so one does not have to update all nodes manually, but instead, duplicate terms can be merged automatically into the primary term as synonyms.
Can we remove those topical tags from the page again? (including or excluding the two in #8)
Comment #11
pillarsdotnet commentedOkay, new list based on http://drupal.org/files/issues/drupalorg-tags-drupal-top100.txt
Comment #12
pillarsdotnet commentedHow is "DX" different from "API clean-up" ?
Comment #13
sunI've the impression that you'd like to keep some of the topic tags and perhaps even advance on them. That's probably fine, when done on a separate page. Thus, I'd recommend to split into two pages:
The former listing most of the tags currently contained on the page -- tags that have a special meaning and may imply a certain workflow. These are indeed "official" and standardized, and do not change often.
The latter listing tags that have been widely adopted to steer and channel interest and contributions -- not having any special meaning.
Issue tags with special meaning:
All others should be topical tags. I'll iterate over them in a separate follow-up.
Comment #14
pillarsdotnet commentedActually, since the "Topical issue tags" apply to contrib as well as core, they should probably go on a page labeled "General-Purpose Issue tags (not specific to any particular project)"
Comment #15
pillarsdotnet commentedAdded General-purpose Issue Tags for documenting topical tags that are not specific to Drupal core (or any other project).
Feel free to move and/or copy tags from http://drupal.org/node/1207020 to http://drupal.org/node/1208166 as you see fit.
Comment #16
sunTopical tags from the current page:
Accessibility, drupal.org upgrade, Documentation, DX, Favorite-of-Dries, Novice, Quick fix, Usability
Topical tags from list in #11 mapping to a D8 core initiative:
html5, D8MI, cmi, wscci
Noteworthy topical, self-explanatory tags:
Update manager, JavaScript, RDF, CSS, PostgreSQL, MySQL, GHOP, GSOC, cron, Ajax
Non-obvious noteworthy topical tags:
- DrupalWTF: As previously documented, strange design or behavior.
- DX: Enhances experience for developers who want to code against an API.
- i18n / i18n sprint: Improves an aspect pertaining to internationalization (i18n), localization (l10n), or translation.
- Translatable fields: Fixes or improves translatable fields support. Needed by language system maintainers to coordinate efforts, especially with regard to moving http://drupal.org/project/entity_translation into core.
- IA: Improves Information Architecture.
- RTL: Right-To-Left language improvements.
- DIE: Attempts to get rid of stone-age code or functionality in core.
- Regression: Fixes a regression to earlier releases. [Might make sense to list this is a special tag]
They are similar but not the same. DX attempts to improve something for developers. API clean-up rather "fixes" something for consistency, performance, modularization, flexibility, third-party integration, etc. Not necessarily improving DX, but of course, that should ideally be the case ;)
The same applies to many of the special issue tags. Especially with regard to all "Needs *" tags. I'd suggest to simply remove the "for Drupal core" suffix from the handbook page titles, and perhaps merely state in a short intro sentence that their primary usage is in core, but some contrib projects use them, too.
Comment #17
pillarsdotnet commentedI'd rather have one page listing core-specific meanings and a separate page for general-purpose meanings, even if there's some overlap.
Comment #18
pillarsdotnet commentedI'm not sure if your pluralization is intentional or accidental, but I only wrote one handbook page with that suffix.
Comment #19
pillarsdotnet commentedAfter re-reading your comments twice more, I think that you want to separate "topical" tags from "workflow" tags.
Is that correct?
Comment #20
pillarsdotnet commentedOkay, I'm still fuzzy on the distinction between "topical" and "special" but I'm okay with the outcome.
Comment #21
sunAlright, as a last step, I've clarified some of the tag descriptions on http://drupal.org/node/1207020
Comment #22
pillarsdotnet commentedGonna call this fixed. The page ain't perfect, but it's way better than nothing.
Comment #23
sunYou removed some explanations for why the tags are "special". Going to restore those now.