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

Replace macros Bug and WebkitBug by regular MD links #24834

Merged
merged 6 commits into from
Feb 26, 2023

Conversation

teoli2003
Copy link
Contributor

Content counterpart of mdn/yari#8298

@teoli2003 teoli2003 requested review from a team as code owners February 24, 2023 10:01
@teoli2003 teoli2003 requested review from willdurand, sideshowbarker, Elchi3, schalkneethling and estelle and removed request for a team February 24, 2023 10:01
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:Glossary Glossary entries Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:JS JavaScript docs Content:Learn Learning area docs Content:Media Media docs Content:Other Any docs not covered by another "Content:" label Content:WebAPI Web API docs Content:WebExt WebExtensions docs labels Feb 24, 2023
@@ -42,7 +42,7 @@ Some syntax, like the one of {{HTTPHeader("Accept")}}, allow additional specifie

### Firefox

Starting with Firefox 18, the quality factor values are clamped to 2 decimal places. They used to be clamped to only 1 decimal place in earlier versions ({{bug(672448)}}).
Starting with Firefox 18, the quality factor values are clamped to 2 decimal places. They used to be clamped to only 1 decimal place in earlier versions ([Firefox bug 672448](https://bugzilla.mozilla.org/show_bug.cgi?id=672448)).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could we use the shortlinks instead, i.e. https://bugzil.la?

Suggested change
Starting with Firefox 18, the quality factor values are clamped to 2 decimal places. They used to be clamped to only 1 decimal place in earlier versions ([Firefox bug 672448](https://bugzilla.mozilla.org/show_bug.cgi?id=672448)).
Starting with Firefox 18, the quality factor values are clamped to 2 decimal places. They used to be clamped to only 1 decimal place in earlier versions ([Firefox bug 672448](https://bugzil.la/672448)).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why? This adds a redirection and an extra request:
Capture d’écran 2023-02-24 à 11 25 41

Copy link
Collaborator

Choose a reason for hiding this comment

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

bugzil.la, webkit.org/b and crbug.com are shorter and thus, much easier to read (which helps contributors). I don't know about MDN as a whole, but BCD has a policy in place to use shortlinks for bug links. (Maybe someone can confirm if there is an MDN-wide policy for these cases.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There isn't but I have no problem using them. No reason to do differently.

Let me fix this

@teoli2003 teoli2003 requested review from a team and Ryuno-Ki and removed request for a team February 24, 2023 16:34
@github-actions github-actions bot added the Content:SVG SVG docs label Feb 24, 2023
@teoli2003
Copy link
Contributor Author

Fixed. Note that as we don't have linting on this, this will diverge; I don't think it is a problem, though.

@sideshowbarker sideshowbarker removed their request for review February 25, 2023 10:04
@@ -165,10 +165,10 @@ Most macros will also take a second argument allowing you to change the display

- Bugs
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should actually remove this entire section; it's talking strictly about the bug macros which will be removed soon!

@github-actions
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:CSS Cascading Style Sheets docs Content:Glossary Glossary entries Content:HTML Hypertext Markup Language docs Content:HTTP HTTP docs Content:JS JavaScript docs Content:Learn Learning area docs Content:Media Media docs Content:Other Any docs not covered by another "Content:" label Content:SVG SVG docs Content:WebAPI Web API docs Content:WebExt WebExtensions docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants