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

remove outdated hgroup content #18530

Merged
merged 1 commit into from
Jul 19, 2022
Merged

remove outdated hgroup content #18530

merged 1 commit into from
Jul 19, 2022

Conversation

scottaohara
Copy link
Contributor

@scottaohara scottaohara commented Jul 19, 2022

The <hgroup> element was recently significantly revised in the HTML specification. The warnings about its impact on the outline algorithm are no longer relevant, as the concept of the outline algorithm was removed from the HTML specification as well.

This PR simply removes outdated content, and replaces the remaining bits with content that is more inline with the current definition for the element.

Note: I anticipate that there may be other things that people might want to call out for this element. That'd make sense. My primary goal here was to remove no longer valid information. Whether any additional content is added to this PR or a following one makes little difference to me, other than the fact we probably don't want to be misaligned with the HTML spec for too long.

Oh yeh, and this closes #11153

This PR…

  • Adds a new document
  • Rewrites (or significantly expands) a document
  • Fixes a typo, bug, or other error

The [`<hgroup>` element](https://html.spec.whatwg.org/multipage/sections.html#the-hgroup-element) was recently significantly revised in the HTML specification. The warnings about its impact on the outline algorithm are no longer relevant, as the concept of the outline algorithm was removed from the HTML specification as well.

This PR simply removes outdated content, and replaces the remaining bits with content that is more inline with the current definition for the element.
@scottaohara scottaohara requested a review from a team as a code owner July 19, 2022 23:00
@scottaohara scottaohara requested review from schalkneethling and removed request for a team July 19, 2022 23:00
@github-actions github-actions bot added the Content:HTML Hypertext Markup Language docs label Jul 19, 2022
@github-actions
Copy link
Contributor

Preview URLs

Flaws

URL: /en-US/docs/Web/HTML/Element/hgroup
Title: <hgroup>
on GitHub
Flaw count: 13

  • macros:
    • wrong xref macro used (consider changing which macro you use)
    • /en-US/docs/Web/HTML/Element/h1 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h2 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h3 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • /en-US/docs/Web/HTML/Element/h4 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements
    • and 8 more flaws omitted

External URLs

URL: /en-US/docs/Web/HTML/Element/hgroup
Title: <hgroup>
on GitHub

No new external URLs

@scottaohara
Copy link
Contributor Author

can anyone explain what these 'flaws' are about? if i'm reading this right, they're largely related to references to other HTML elements which i didn't touch?

Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

Huge thank you!

@estelle estelle merged commit 59abae8 into main Jul 19, 2022
@estelle estelle deleted the hgroup-cleanup branch July 19, 2022 23:21
@estelle
Copy link
Member

estelle commented Jul 19, 2022

The flaws were in the page and are not due to your edits. A macro in the page pulls in content that has links to h1-h6 pages which have entries in the _redirects.txt to a single 'heading_elements' page. When there is a link that leads to a redirect it is a 'flaw' not an error, since the link will still work. Hope that helps.

@scottaohara
Copy link
Contributor Author

@estelle what's the general turnaround time for this to appear on the mdn website?

@teoli2003
Copy link
Contributor

The production Web site is usually built once a day; read this section for more information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:HTML Hypertext Markup Language docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Content bug: <hgroup> a valid HTML element that can be used
3 participants