Skip to content

Add documention for json data files in mdn/content - #8100

Merged
sideshowbarker merged 15 commits into
mdn:mainfrom
teoli2003:document-json-files
Aug 19, 2021
Merged

sideshowbarker merged 15 commits into
mdn:mainfrom
teoli2003:document-json-files

Conversation

@teoli2003

@teoli2003 teoli2003 commented Aug 19, 2021 •

Copy link
Copy Markdown
Contributor

Fixes #8037

In #8019, @peterbe is migrating json files from mdn/yari to mdn/content.

This document the structure of the important ones.

It doesn't document the l10n-* files that only tech-savvy localizers modify (and rarely, likely less than once a year), nor the svg-related one that is quite complex and in used on SVG that is practically unmaintained. This would not have been very useful, I think.

But the two files used each week are documented, as well as SpecData.json deprecated but we receive sometimes PRs for it.

The links to the files on Github will start working only once #8019 has landed.

@teoli2003
teoli2003 requested review from a team and Elchi3 and removed request for a team August 19, 2021 15:27
@github-actions

github-actions Bot commented Aug 19, 2021 •

Copy link
Copy Markdown
Contributor

Preview URLs

Flaws

None! 🎉

External URLs

URL: /en-US/docs/MDN/Guidelines/JSON_Structured_Data
Title: Structured data on MDN
on GitHub

No new external URLs

(this comment was updated 2021-08-19 16:34:31.833199)

@teoli2003
teoli2003 requested a review from Rumyra August 19, 2021 15:30

@sideshowbarker sideshowbarker left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. All I have are copy-editing nits.

teoli2003 and others added 14 commits August 19, 2021 18:30
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
@Elchi3

Elchi3 commented Aug 19, 2021

Copy link
Copy Markdown
Member

Drive-by comment since I got email about all the commits: Use "Add suggestion to batch" to accept multiple suggestions at once. https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request#applying-suggested-changes

@teoli2003

Copy link
Copy Markdown
Contributor Author

Drive-by comment since I got email about all the commits: Use "Add suggestion to batch" to accept multiple suggestions at once. https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request#applying-suggested-changes

Oh, I didn't know about this feature! I usually edit the text, but as they were a lot I didn't! Thanks, and sorry!

@sideshowbarker
sideshowbarker merged commit 76f5167 into mdn:main Aug 19, 2021
@hamishwillee

Copy link
Copy Markdown
Collaborator

Use "Add suggestion to batch" to accept multiple suggestions at once.

I don't know why, but for some reason this doesn't work on all repos. Is there a setting to enable it?

@sideshowbarker

Copy link
Copy Markdown
Member

Use "Add suggestion to batch" to accept multiple suggestions at once.

I don't know why, but for some reason this doesn't work on all repos. Is there a setting to enable it?

There isn’t — as far I can see from checking the settings in other repos where I have admin perms.

On thing, though, is that it only works when you review from the Files changed tab; e.g., https://github.com/mdn/content/pull/8100/files — it doesn’t work when you instead review from the Commits tab; e.g., https://github.com/mdn/content/pull/8100/commits

@peterbe

peterbe commented Aug 20, 2021

Copy link
Copy Markdown
Contributor

Use "Add suggestion to batch" to accept multiple suggestions at once.

I don't know why, but for some reason this doesn't work on all repos. Is there a setting to enable it?

If it doesn't work it might be because you're not on the "Files" tab.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Aug 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document json files like InterfaceData.json and GroupData.json

5 participants