Renamed the required `manifest.jsonld` to `publication.json`
Closed this issue · 5 comments
Since this spec will force the naming of files, we should consider changing manifest.jsonld to publication.jsonld to avoid confusing with the frequently used manifest.json by Web Application Manifest users.
Potentially, we may also want to consider using .json vs. .jsonld as development tools are more likely to "naturally" open .json files and may not have .jsonld file extensions mapped (yet).
So, the suggestion is to rename manifest.jsonld to publication.json.
Since this spec will force the naming of files, we should consider changing manifest.jsonld to publication.jsonld to avoid confusing with the frequently used manifest.json by Web Application Manifest users.
AFAIK there's no well-known name or location for a WAM and it isn't really meant to be packaged that way, so I don't think we're likely to have a lot of confusion.
That said I'm personally fine with publication.json as an alternative to manifest.jsonld.
It's not required anywhere (by design; because webby), but it is frequently the suggested name in examples/tools--for instance https://dev.opera.com/articles/installable-web-apps/
Also, in the Web App Manifest spec itself it's manifest.webmanifest.
And, manifest.json is also used in Browser Extensions--which are packaged:
https://browserext.github.io/browserext/
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Anatomy_of_a_WebExtension#manifest.json
So, avoiding name collision (since we are dictating names) seems valuable.
This issue was discussed in a meeting.
RESOLVED: go with publication.json
View the transcript
Garth Conboy: #43Laurent Le Meur: Next is #43 - rename the manifest jsonld to publication.json
Ivan Herman: From a JSON LD point of view, either is fine. The original comment is about avoiding using the word manifest - which is used all over the place
Proposed resolution: go with manifest.json (Garth Conboy)
Ivan Herman: +1
Garth Conboy: +1
Laurent Le Meur: +1
Joshua Pyle: +1
Deborah Kaplan: +1
Benjamin Young: The proposal says go with manifest.json - but the issue is about renaming it to publication. So the proposal should be to use publication.json…
Proposed resolution: Go with publication.json (Garth Conboy)
Brady Duga: +1
Nick Ruffilo: +1 to publication.json
Geoff Jukes: +1 to publication.json
Ben Schroeter: +1 to use publication.json
Ric Wright: +1
Benjamin Young: +1 to publication.json
Charles LaPierre: +1
Joshua Pyle: +1 publication.json
George Kerscher: +1
Wendy Reid: +1 to publication.json
Rachel Comerford: +1
Garth Conboy: Resolved…
Resolution #4: go with publication.json