Closed Bug 1251252 Opened 8 years ago Closed 7 years ago

Allow empty Section names

Categories

(developer.mozilla.org Graveyard :: BrowserCompat, defect)

All
Other
defect
Not set
normal

Tracking

(Not tracked)

RESOLVED WONTFIX

People

(Reporter: jwhitlock, Unassigned)

References

Details

(Keywords: in-triage, Whiteboard: [bc:infra][bc:milestone=bicycle])

What problem would this feature solve?
======================================
The {{SpecName}} macro [1] allows omitting the anchor and anchor name. The API Section resource [2] requires a name, but allows the subpath to be empty. These are currently being imported as localized, empty strings ( {"en": ""} ), needlessly increasing the translation work.

[1] https://developer.mozilla.org/en-US/docs/Template:SpecName
[2] http://browsercompat.readthedocs.org/en/latest/v1/resources.html#sections

Who has this problem?
=====================
Core contributors to MDN

How do you know that the users identified above have this problem?
==================================================================
Translators currently have to translate all the compatibility data, and part of this project is to focus their efforts on the translatable strings.

How are the users identified above solving this problem now?
============================================================
Translators would have to confirm that an empty string in English is also an empty string in their language.

Do you have any suggestions for solving the problem? Please explain in detail.
==============================================================================
Convert Section.name into an optional translated field as a two-step process

PR #1:
* Update the Django model to add blank=True
* Apply the migration to the production database

PR #2
* Migrate blank names to empty 
* Update the v1 and v2 API documentation to mark it as optional
* Confirm the sample views can handle empty section names
* Update the MDN importer to treat omitted anchor names as omitted section names


Is there anything else we should know?
======================================
The MDN importer also imports empty notes and omitted anchors as translated strings. Empty notes will be covered by bug 1216786, which moves notes to the new references resource. Converting omitted anchors to omitted subpaths can be done with this work.
Assignee: nobody → jwhitlock
Blocks: 1240757
Severity: enhancement → normal
See Also: → 1216786
Whiteboard: [specification][type:feature] → [specification][type:feature][bc:infra][bc:milestone=bicycle]
Status: NEW → ASSIGNED
Revert assignment as the project is currently on hold.
Assignee: jwhitlock → nobody
Status: ASSIGNED → NEW
Whiteboard: [specification][type:feature][bc:infra][bc:milestone=bicycle] → [bc:infra][bc:milestone=bicycle]
The BrowserCompat project is canceled.  See https://github.com/mdn/browsercompat for current effort. Bulk status change includes the random word TEMPOTHRONE.
Status: NEW → RESOLVED
Closed: 7 years ago
Resolution: --- → WONTFIX
Product: developer.mozilla.org → developer.mozilla.org Graveyard
You need to log in before you can comment on or make changes to this bug.