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

doc: remove http2 non-link anchor tags #35161

Merged
merged 1 commit into from
Sep 14, 2020
Merged

doc: remove http2 non-link anchor tags #35161

merged 1 commit into from
Sep 14, 2020

Conversation

Trott
Copy link
Member

@Trott Trott commented Sep 12, 2020

Headers have ids automatically assigned. Removed ad hoc ids using anchor
tags that aren't links.

Checklist

@Trott Trott requested review from a team as code owners September 12, 2020 03:26
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/http2
  • @nodejs/net

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem. labels Sep 12, 2020
@Trott
Copy link
Member Author

Trott commented Sep 12, 2020

@DerekNonGeneric @aduh95

@addaleax
Copy link
Member

I kind of wish we’d go into the opposite direction more often – these anchor tags allow creating permanently functional links from other websites to the documentation, while the automatically generated anchors can easily change even when only a minor change to the header text was performed and break those links. I would keep them.

@Trott
Copy link
Member Author

Trott commented Sep 12, 2020

I kind of wish we’d go into the opposite direction more often – these anchor tags allow creating permanently functional links from other websites to the documentation, while the automatically generated anchors can easily change even when only a minor change to the header text was performed and break those links. I would keep them.

I can definitely support that to accommodate links from external pages, but these were apparently created to have links from within the page, and I'm not sure we want to encourage that.

@Trott
Copy link
Member Author

Trott commented Sep 14, 2020

Landed in b569376

@Trott Trott merged commit b569376 into nodejs:master Sep 14, 2020
@Trott Trott deleted the http2-ids branch September 14, 2020 04:43
Headers have ids automatically assigned. Removed ad hoc ids using anchor
tags that aren't links.

PR-URL: nodejs#35161
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@ruyadorno
Copy link
Member

this change doesn't land cleanly on v14.x, should it be backported?

Trott added a commit to Trott/io.js that referenced this pull request Sep 25, 2020
Headers have ids automatically assigned. Removed ad hoc ids using anchor
tags that aren't links.

PR-URL: nodejs#35161
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@Trott
Copy link
Member Author

Trott commented Sep 25, 2020

this change doesn't land cleanly on v14.x, should it be backported?

@ruyadorno Backport in #35334.

MylesBorins pushed a commit that referenced this pull request Sep 29, 2020
Headers have ids automatically assigned. Removed ad hoc ids using anchor
tags that aren't links.

Backport-PR-URL: #35334
PR-URL: #35161
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Sep 29, 2020
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
Headers have ids automatically assigned. Removed ad hoc ids using anchor
tags that aren't links.

PR-URL: nodejs#35161
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants