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.

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

fix(docs): add a page describing everything about feature statuses #31941

Merged
merged 21 commits into from
Feb 22, 2024

Conversation

OnkarRuikar
Copy link
Contributor

@OnkarRuikar OnkarRuikar commented Jan 26, 2024

We've been using a bot to update statuses (experimental, deprecated, and non-standard) stored in BCD repo. Since the bot automatically does the update it is no longer required to manually provide status information in the content repo.
If the information is provided manually then it may cause conflict with the bot.

The PR:

  • adds a new page which explains
    • the statuses
    • update procedure in BCD
    • a warning about updating them manually
    • mechanisms used to render the statuses in sidebars, header banners, and inline badges
  • updates rest of the pages under /files/mdn
    • removes manual update instructions
    • adds links to the new page
    • adds missing information
  • fixes typos

Start the review with the new page: https://pr31941.content.dev.mdn.mozit.cloud/en-US/docs/MDN/Writing_guidelines/Page_structures/Technology_status

/cc @Rumyra @teoli2003 @dipikabh

@OnkarRuikar OnkarRuikar requested a review from a team as a code owner January 26, 2024 14:34
@OnkarRuikar OnkarRuikar requested review from hamishwillee and removed request for a team January 26, 2024 14:34
@github-actions github-actions bot added Content:Meta Content in the meta docs size/xl [PR only] >1000 LoC changed labels Jan 26, 2024
Copy link
Contributor

github-actions bot commented Jan 26, 2024

Preview URLs (22 pages)
External URLs (2)

URL: /en-US/docs/MDN/Writing_guidelines/Page_structures/Macros
Title: Using macros


URL: /en-US/docs/MDN/Writing_guidelines/Page_structures/Feature_status
Title: Feature status

(comment last updated: 2024-02-21 13:49:23)

@Rumyra Rumyra requested review from chrisdavidmills and bsmth and removed request for hamishwillee January 26, 2024 14:51
@Rumyra
Copy link
Collaborator

Rumyra commented Jan 26, 2024

I'm assigning this to @bsmth and @chrisdavidmills - this all looks good @OnkarRuikar but I'd like a discussion about the naming of the new area (not 100% on 'standardization') - we also have a bit of work around a new notification for one of the apis and I don't want this to directly conflict with that, so putting Brian & Chris' eyes on it directly shoudl help 👍

@OnkarRuikar
Copy link
Contributor Author

I'd like a discussion about the naming of the new area (not 100% on 'standardization')

Simply calling it status (as we've been doing in code) is not sufficient.
How about:

  • feature status
  • technology status
  • item status

@bsmth
Copy link
Member

bsmth commented Jan 26, 2024

  • feature status
  • technology status

I like both of these and they're congruent with https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Experimental_deprecated_obsolete

Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

Could we change:

Standardization -> Technology

@OnkarRuikar OnkarRuikar changed the title fix(docs): add a page describing everything about standardization statuses fix(docs): add a page describing everything about technology statuses Jan 26, 2024
@bsmth
Copy link
Member

bsmth commented Jan 26, 2024

Thanks, @OnkarRuikar I am done with that review round. Feel free to ignore/resolve the style comments, mostly some suggestions on technology_status/index.md for you to consider.

@OnkarRuikar
Copy link
Contributor Author

Minimally we should document this here, even just like "If a page includes more than one BCD entry in the browser-compat key, then only the first entry is used to provide feature status values".

Done in above commit.

OnkarRuikar and others added 21 commits February 21, 2024 19:17
Co-authored-by: Brian Thomas Smith <brian@smith.berlin>
Co-authored-by: Brian Thomas Smith <brian@smith.berlin>
Co-authored-by: Brian Thomas Smith <brian@smith.berlin>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
…_notices/index.md

Co-authored-by: wbamberg <will@bootbonnet.ca>
Co-authored-by: wbamberg <will@bootbonnet.ca>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

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

👍 thank you Onkar!

Copy link
Collaborator

@hamishwillee hamishwillee left a comment

Choose a reason for hiding this comment

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

The most active reviewers have now approved. Any reason not to merge?

@wbamberg wbamberg merged commit cb1c745 into mdn:main Feb 22, 2024
9 checks passed
@wbamberg
Copy link
Collaborator

The most active reviewers have now approved. Any reason not to merge?

I was waiting for you! :)

@OnkarRuikar OnkarRuikar deleted the docs_status_guidline branch February 23, 2024 04:38
@OnkarRuikar
Copy link
Contributor Author

Thank you all for the valuable inputs!

@hamishwillee
Copy link
Collaborator

Thanks @OnkarRuikar - you've made things better, as always.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Meta Content in the meta docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants