Closed Bug 1280225 Opened 8 years ago Closed 6 years ago

Unify data from {{SpecName}} and {{spec2}} within a new JSON file

Categories

(Developer Documentation Graveyard :: Macros/Templates, enhancement)

enhancement
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: sebo, Unassigned)

References

Details

The information about the specifications is currently split into two templates, one for the name and URL and one for its status.

I believe this data should be merged into a central {{SpecData}} template (according to the existing CSSData, SVGData, etc. templates) and {{SpecName}} and {{spec2}} should be changed to fetch their data from the new template.

Those two templates may also be replaced by a new template {{specinfo()}} instead or as follow-up, which allows to generate the output via a parameter indicating the type of data to display. Or they may be replaced by two new templates {{speclink()}} and {{specstatus()}} (because the current names do not perfectly match their purpose).

Sebastian
Blocks: 1311276
In our new mdn/data repository, how would this suit there?

I can imagine two options:

api/specifications.json
css/specifications.json
svg/specifications.json

or

/specifications.json
Specifications often define items from different categories. E.g. SVG 2 defines SVG elements, related APIs and CSS properties. So, I prefer a global /specifications.json (or /specs.json) to avoid redundant definitions.

Sebastian
Excellent point. I agree!
I agree too.

Info we need per spec:
- Id (shortname): 'CSS Grids'
- Full name: 'CSS Grid Layout Module Level 1'
- Link: 'https://drafts.csswg.org/css-grid/'
- Org handling it: 'CSSWG'
- Process (W3C, Living, IETF, …): 'W3C'
- Status (depends of the process): 'CR'

The definition status for each process should be in this file too (W3C: Note, Draft, CR, PR, REC; WHATWG: Living; IETF: Note, Standard Track, Propposed Standard, …)
I think we would want this as a JSON file in https://github.com/mdn/data now.
See also https://github.com/mdn/data/issues/56
Summary: Unify data from {{SpecName}} and {{spec2}} within a new template → Unify data from {{SpecName}} and {{spec2}} within a new JSON file
Looks like that was done in https://github.com/mdn/kumascript/commit/0279c28ed939d80bc08c25430cf04437ed9bfbdd, right?

Sebastian
Flags: needinfo?(jwhitlock)
This is close enough for me, yes.

The union of the data is in SpecData.json:

https://github.com/mdn/kumascript/blob/master/macros/SpecData.json

In the future it could be moved to mdn/data. {{SpecName}} and {{spec2}} load the data from the file.

:fscholz, :teoli, feel free to open follow-on bugs or issues for the other desired design changes.
Status: NEW → RESOLVED
Closed: 6 years ago
Flags: needinfo?(jwhitlock)
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.