Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rationalize top-level Web API pages #1579

Closed
8 tasks
wbamberg opened this issue Aug 10, 2020 · 2 comments
Closed
8 tasks

Rationalize top-level Web API pages #1579

wbamberg opened this issue Aug 10, 2020 · 2 comments
Labels
Content:Other Any docs not covered by another "Content:" label

Comments

@wbamberg
Copy link
Collaborator

According to mdn/sprints#3327 we have ~1100 pages directly under Web/API.

I believe that every page directly under Web/API must be one of:

  1. an API overview page, e.g. https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
  2. an interface page, e.g. https://developer.mozilla.org/en-US/docs/Web/API/Request
  3. a dictionary page, e.g. https://developer.mozilla.org/en-US/docs/Web/API/AesGcmParams

While it's hard to tell which pages are in group (1), a reasonable heuristic seems to be: if the title contains a space, the page is an API overview page. But that heuristic we have about 100 API overview pages, leaving about 1000 others.

As far as I know, all the others ought to be either interface pages or dictionary pages, so ought to be listed in GroupData.json. In fact, ~250 of these pages are not listed in GroupData.

Additionally, some interfaces/dictionaries appear under more than one group in GroupData. I believe that this should not be allowed.

So we should:

  • tag API overview pages, so we know exactly which ones they have
  • ensure all API overview pages have a corresponding entry in GroupData.json
  • tag all dictionary pages
  • ensure all dictionary pages are listed under an entry in GroupData.json
  • tag all interface pages
  • ensure all interface pages are listed under an entry in GroupData.json
  • relocate or delete any other pages that aren't in one of these three categories
  • remove any duplicate interface/dictionary entries from GroupData
@chrisdavidmills chrisdavidmills transferred this issue from mdn/sprints Jan 21, 2021
@chrisdavidmills chrisdavidmills added the Content:Other Any docs not covered by another "Content:" label label Jan 21, 2021
@github-actions github-actions bot added the idle label Nov 24, 2021
MendyBerger pushed a commit to MendyBerger/content that referenced this issue Nov 30, 2021
@ikarasz
Configure eslint and standardize the stylequide all over the js examp…
1d6085a 
…les (mdn#1579)

* configure eslint

* fix eslint errors

* rename class

* add missing curly braces

* add missing empty line

* allow one line declaration in specific file

* allow missing block after for

* enforce eol as last character

* enforce template literals

* enforce no-var eslint rule

* enforce prefer-arrow-callback eslint rule

* enforce comma-spacing eslint rule

* enforce comma-style eslint rule

* enforce func-call-spacing eslint rule

* enforce key-spacing eslint rule

* enforce keyword-spacing eslint rule

* enforce no-multiple-empty-lines eslint rule

* enforce no-trailing-spaces eslint rule

* enforce space-before-function-paren eslint rule

* enforce indentation within switch statements

* enforce 1tbs brace-style with allowSingleLine option

* enforce no-array-constructor eslint rule

* enforce no-new-object eslint rule

* enforce space-infix-ops eslint rule

* enforce no-else-return eslint rule

* add styleguide check to travis

* add syntax highlight to the contributing md

* adjust styleguide in the contributing md

* remove osolated examples from the contribution guidelines

* remove unnecessary empty lines from contribution guidelines

* add override example to the contribution guidelines

* remove outdated styleguide hints
@wbamberg wbamberg reopened this May 28, 2022
@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label May 28, 2022
@sideshowbarker sideshowbarker removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label May 28, 2022
@sideshowbarker
Copy link
Member

As this one is nearing 2 years without any updated, I suggest we consider closing it and maybe instead perhaps adding to the OWD work list (if it’s not already included there) — following the general principle that it’s good to not keep issues open indefinitely without any associated updates to the content.

@wbamberg
Copy link
Collaborator Author

Fair enough. I still think this is worth doing but it's obsolete at least in that it talks about using tags rather than page types, and it might (I hope) be obsoleted by openwebdocs/project#76, so I'm less invested in getting it done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Content:Other Any docs not covered by another "Content:" label
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@chrisdavidmills @sideshowbarker @wbamberg