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

pillarsdotnet’s picture

Status: Active » Needs review
dddave’s picture

Great write-up.

Do we need a consistent policy about capitalization? At the moment sometimes we have "needs..." or "Needs..." and "Performance" but "accessibility".

pillarsdotnet’s picture

Dunno. I documented what is, not what should be. I don't have the ability to change the capitalization of the existing tags.

sun’s picture

Status: Needs review » Fixed
  1. Fixed the HTML markup on that page. Whoever invalidly intermixed definition list terms and descriptions into a UL structure, please read the HTML spec about definition lists.
  2. Fixed capitalization of issue tags. I know that some of the tags are improperly capitalized on d.o, but that doesn't matter for those links, since Taxonomy module matches case-insensitive.
  3. Fixed encoding of URLs.
  4. Added API clean-up tag.

This looks done to me. Further tags may naturally be added over time.

Thanks for the kick-starting it!

pillarsdotnet’s picture

Changed the urls back to lowercase and moved each definition to a single line for easier alphabetical sorting.

pillarsdotnet’s picture

Status: Needs review » Fixed

Here are the top 100 tags as provided by Damien Tournoud in #1207026: Please give a list of all tags:

Tag name Purpose or Meaning
module review Not core.
Usability Documented.
drupal.org redesign Not core.
views Documented.
Novice Documented.
git phase 2 Not core.
needs backport to D7 Documented.
Quick fix Documented.
accessibility Documented.
Run-Time Environment Data Model Compliance Requirements Not core (SCORM project, module abandoned, turned over to new maintainer).
Needs tests Documented.
Performance Documented.
Needs Documentation Documented.
D7UX I'm not sure how this tag differs from Usability.
CSS Documented.
Newbie Use Novice instead.
drupal.org upgrade Documented.
translation I'm not sure how this tag differs from "i18n", or which is preferred.
API clean-up Documented.
JavaScript Documented.
GHOP Historical tag, no longer applied to new issues. Use "novice" perhaps?
CCK Do we want to use this field any more, since we now call it "fields" rather than "cck"?
Needs usability review Documented.
taxonomy Should the use of this tag be deprecated in favor of selecting the taxonomy.module component?
API change Documented.
documentation Documented.
D7 upgrade path Documented.
Ubercart Not core.
Release blocker How is this tag different from a priority of "Critical"?
i18n I'm not sure how this tag differs from "translation", or which is preferred.
drupal.org redesign qa Not core.
#d7ux How is this different from "D7UX" or "Usability"?
PostgreSQL Documented.
Intermediate Historical tag? Not applied to any currently open issues.
needs backport to D6 Documented.
token Historical tag? Not applied to any currently open issues.
theme Historical tag? Not applied to any currently open issues.
panels Not core.
needs backport to D7 Documented.
theme review Historical tag? Not applied to any currently open issues.
drupal 7 How is this tag different from selecting the appropriate version?
D7 porting Historical tag? Not applied to any currently open issues.
PHP 5.3 Documented.
jQuery Documented.
DrupalWTF Documented.
Ajax How is this different from selecting the "ajax system" component?
git sprint 8 Not core.
D7 How is this tag different from selecting the appropriate version?
Run-Time Environment Data Model Data Type Compliance Requirements SCORM.
error Historical or deprecated tag? Not applied to any currently open issues.
drupal.org redesign project Not core.
patch Should this tag be used?
coding standards Documented.
block
french
d7docs
html5
Update manager
RDF
API Implementation Compliance Requirements
DX (Developer Experience) Documented
theming
webform
Favorite-of-Dries Documented.
date
menu
Security improvements Should this be deprecated in favor of the shorter "security" tag?
image
ui-text
permissions
low-hanging fruit
drush
drupal.org redesign content
ckeditor-7.x
developer
UMN+2011
i18n sprint
git phase 3
Needs design review
dcsprint5
rules integration
search
beta blocker
security
rules
Fields in Core
location
git sprint 9
Legal
pathauto
vertical tabs
imagecache
DBTNG Conversion
git sprint 7
git
di18nscb
node
Libraries
handbook Documented.
pillarsdotnet’s picture

Status: Fixed » Needs review
sun’s picture

Status: Fixed » Needs review

ugh. 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.

pillarsdotnet’s picture

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.

There are at least five tags dealing with PHP 5.3 and I think we should standardize on one of them.

sun’s picture

There 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)

pillarsdotnet’s picture

Okay, new list based on http://drupal.org/files/issues/drupalorg-tags-drupal-top100.txt

Usability
Documented.
needs backport to D7
Documented.
Quick fix
Documented.
Novice
Documented.
Needs tests
Documented.
Performance
Documented.
Accessibility
Documented.
D7UX
Probably should be replaced by "Usability" plus selection of the appropriate core version.
Performance
Documented.
API clean-up
Documented.
Needs Documentation
Documented.
D7 upgrade path
Documented, but of debatable value.
Needs usability review
Documented.
API change
Documented.
needs backport to D7
Documented.
needs backport to D6
Documented.
DrupalWTF
Invalid topical tag.
Update manager
How is this different from selecting the "database update system" component?
Favorite-of-Dries
Documented.
DX (Developer Experience)
Documented as the shorter "dx" tag.
ui-text
How is this different from the "Usability" tag?
#d7ux
Does this relate to an IRC channel?
JavaScript
Invalid topical tag.
Needs design review
I'm not sure what this tag means, even after reviewing the issues tagged with it.
html5
Not yet documented
UMN 2011
Historical tag that should not be part of a permanent handbook page.
Fields in Core
Not yet documented.
Security improvements
How is this different from the shorter "security" tag?
RDF
Probably should select the rdf.module component instead.
DBTNG Conversion
Historical tag?
coding standards
Documented, but of debatable value.
UBUserTesting2009
Historical tag?
string freeze
Documented.
i18n sprint
Historical tag?
documentation
Documented.
CSS
Invalid topical tag.
Needs Update Documentation
Documented.
D7UX usability
How is this different from the "Usability" tag plus selection of the appropriate core version?
Translatable fields
Historical tag?
Needs text review
Is this like asking for a spell-check?
D7 API clean-up
Probably should use "API clean-up"> plus selection of the appropriate core version.
FilterSystemRevamp
Historical tag?
d7help
Probably should select the "help.module" component plus the appropriate core version, instead.
IA
Not yet documented. (What does this mean, anyway?)
API addition
Documented.
PostgreSQL
Invalid topical tag.
Security Advisory follow-up
Not yet documented.
Newbie
Use Novice instead.
token
Invalid topical tag.
CSS aggregation
Invalid topical tag.
beta blocker
How is this different from setting the priority to "Critical"?
d7uxsprint
Historical tag?
D7 Form API challenge
Historical tag?
security
Documented.
vertical tabs
Not yet documented.
theme
Not yet documented.
jQuery
Invalid topical tag.
PostgreSQL Surge
Invalid topical tag.
overlay
Not yet documented.
d8ux
Not yet documented.
actions
Not yet documented.
GHOP
documented.
i18n
Not yet documented.
user pictures
Not yet documented.
D8MI
documented.
RTL
documented.
taxonomy
Not yet documented.
webchick's D7 alpha hit list
Not yet documented.
dashboard
Not yet documented.
Needs accessibility review
Documented.
permissions
Not yet documented.
Bartik
Not yet documented.
menu
Not yet documented.
Registry
Not yet documented.
Cleanup
Not yet documented.
Help text
Not yet documented.
entity
Not yet documented.
Drupal
Not yet documented.
MySQL
Not yet documented.
ui-pattern
Not yet documented.
autocomplete
Not yet documented.
database
Not yet documented.
cron
Not yet documented.
FAPI #states
Not yet documented.
Ajax
Not yet documented.
DIE
Not yet documented.
D7 UX freeze
Not yet documented.
regression
Not yet documented.
D7FileAPIWishlist
Not yet documented.
D7csmtl
Not yet documented.
XHTML validation
Not yet documented.
d7docs
Not yet documented.
jQuery UI
Not yet documented.
Needs screenshot
Not yet documented.
caching
Not yet documented.
tpl-refresh
Not yet documented.
drupal.org upgrade
Documented.
Needs committer feedback
Documented.
markup
Not yet documented.
#d8ux
Not yet documented.
pillarsdotnet’s picture

How is "DX" different from "API clean-up" ?

sun’s picture

I'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:

  1. Special issue tags for Drupal core
  2. Topical issue tags for Drupal core

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:

  • API addition: Enhances a current API, possibly backportable.
  • API change: Changes a current API, not backportable (unless a critical bug).
  • API clean-up: Rewrites a current API, not necessarily implying an API change. Top issue tag during "Code Slush" release cycle phase.
  • Coding standards: Requires broad community agreement.
  • Upgrade path: Needs to be resolved before next major release.
  • Needs *: (As the name suggests)
  • Performance: Requires benchmarks, platform tests, etc. More of a topic tag, but Performance is problematic in Drupal.
  • Security: Requires Security Team review.
  • String freeze: Needs to be resolved before string freeze of next major release.

All others should be topical tags. I'll iterate over them in a separate follow-up.

pillarsdotnet’s picture

Actually, 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)"

pillarsdotnet’s picture

Added 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.

sun’s picture

Topical 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]

How is "DX" different from "API clean-up" ?

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 "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)"

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.

pillarsdotnet’s picture

I'd rather have one page listing core-specific meanings and a separate page for general-purpose meanings, even if there's some overlap.

pillarsdotnet’s picture

I'd suggest to simply remove the "for Drupal core" suffix from the handbook page titles

I'm not sure if your pluralization is intentional or accidental, but I only wrote one handbook page with that suffix.

pillarsdotnet’s picture

After re-reading your comments twice more, I think that you want to separate "topical" tags from "workflow" tags.

Is that correct?

pillarsdotnet’s picture

Okay, I'm still fuzzy on the distinction between "topical" and "special" but I'm okay with the outcome.

sun’s picture

Alright, as a last step, I've clarified some of the tag descriptions on http://drupal.org/node/1207020

pillarsdotnet’s picture

Status: Needs review » Fixed

Gonna call this fixed. The page ain't perfect, but it's way better than nothing.

sun’s picture

You removed some explanations for why the tags are "special". Going to restore those now.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.