fix(docs-infra): do not include GitHub links in Table of Content #32418
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gkalpak
added
type: bug/fix
action: merge
scripts/git/commit-msg.js
Outdated
| console.error( | ||
| '\nCheck CONTRIBUTING.md at the root of the repo for more information.' + | ||
| '\n' + | ||
| '\n(In case you need the invalid commit message, it should be stored in \'.git/COMMIT_EDITMSG\'.)'); |
There was a problem hiding this comment.
LOL did you get bitten by this?
There was a problem hiding this comment.
More times than I want to admit 😇
(I thought I had removed this change from this PR. I submitted #32420.)
|
You can preview 129dee6 at https://pr32418-129dee6.ngbuilds.io/. |
petebacondarwin
approved these changes
Aug 30, 2019
petebacondarwin
requested changes
Aug 30, 2019
gkalpak
force-pushed
the
fix-aio-gh-links-in-toc
branch
from
129dee6
to
cab10e0
Compare
|
You can preview cab10e0 at https://pr32418-cab10e0.ngbuilds.io/. |
|
You can preview 48fabd5 at https://pr32418-48fabd5.ngbuilds.io/. |
gkalpak
force-pushed
the
fix-aio-gh-links-in-toc
branch
from
48fabd5
to
dea05af
Compare
|
You can preview dea05af at https://pr32418-dea05af.ngbuilds.io/. |
|
It turns out there was another issue with tooltips ( @petebacondarwin: PTAL 👀 |
petebacondarwin
approved these changes
Aug 30, 2019
petebacondarwin
added
the
action: cleanup
The Table of Contents (ToC) is auto-generated based on the content of heading elements on the page. At the same time, anchor links are auto-generated and added to each heading element. Note that the Material Icons used for the anchor icon make use of ligatures, which means that the icons are specified by using their textual name as text content of the icon element. As a result, the name of the icon is included in the parent element's `textContent`. Previously, the `TocService` used to strip off these anchor elements when generating the content of ToC items, but not when generating the content of their tooltips. Thus, tooltips for ToC items would confusingly include a `link` suffix (`link` is the textual name of the icon used in heading anchor links). This commit fixes this by deriving the tooltip content from the transformed text content (which already has anchor links stripped off), instead of from the original heading content.
The docs template for cli commands ([cli-command.template.html][1]) includes an `h2` element with GitHub links for [long description][2]. Since the content of `h2` elements is replicated in the auto-generated Table of Contents, the GitHub links were replicated as well (which is undesirable). This commit fixes it by explicitly excluding `.github-links` elements, when extracting the content for the ToC (in [TocService#extractHeadingSafeHtml()][3]). This is similar to what we do for the auto-generated `.header-link` anchors. [1]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html [2]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html#L18 [3]: https://github.com/angular/angular/blob/1537791f0/aio/src/app/shared/toc.service.ts#L56
gkalpak
force-pushed
the
fix-aio-gh-links-in-toc
branch
from
dea05af
to
0dd6d5a
Compare
|
You can preview 0dd6d5a at https://pr32418-0dd6d5a.ngbuilds.io/. |
petebacondarwin
removed
the
action: cleanup
matsko
pushed a commit
that referenced
this pull request
Sep 5, 2019
) The docs template for cli commands ([cli-command.template.html][1]) includes an `h2` element with GitHub links for [long description][2]. Since the content of `h2` elements is replicated in the auto-generated Table of Contents, the GitHub links were replicated as well (which is undesirable). This commit fixes it by explicitly excluding `.github-links` elements, when extracting the content for the ToC (in [TocService#extractHeadingSafeHtml()][3]). This is similar to what we do for the auto-generated `.header-link` anchors. [1]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html [2]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html#L18 [3]: https://github.com/angular/angular/blob/1537791f0/aio/src/app/shared/toc.service.ts#L56 PR Close #32418
matsko
pushed a commit
that referenced
this pull request
Sep 5, 2019
…32418) The Table of Contents (ToC) is auto-generated based on the content of heading elements on the page. At the same time, anchor links are auto-generated and added to each heading element. Note that the Material Icons used for the anchor icon make use of ligatures, which means that the icons are specified by using their textual name as text content of the icon element. As a result, the name of the icon is included in the parent element's `textContent`. Previously, the `TocService` used to strip off these anchor elements when generating the content of ToC items, but not when generating the content of their tooltips. Thus, tooltips for ToC items would confusingly include a `link` suffix (`link` is the textual name of the icon used in heading anchor links). This commit fixes this by deriving the tooltip content from the transformed text content (which already has anchor links stripped off), instead of from the original heading content. PR Close #32418
matsko
pushed a commit
that referenced
this pull request
Sep 5, 2019
) The docs template for cli commands ([cli-command.template.html][1]) includes an `h2` element with GitHub links for [long description][2]. Since the content of `h2` elements is replicated in the auto-generated Table of Contents, the GitHub links were replicated as well (which is undesirable). This commit fixes it by explicitly excluding `.github-links` elements, when extracting the content for the ToC (in [TocService#extractHeadingSafeHtml()][3]). This is similar to what we do for the auto-generated `.header-link` anchors. [1]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html [2]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html#L18 [3]: https://github.com/angular/angular/blob/1537791f0/aio/src/app/shared/toc.service.ts#L56 PR Close #32418
sabeersulaiman
pushed a commit
to sabeersulaiman/angular
that referenced
this pull request
Sep 6, 2019
…ngular#32418) The Table of Contents (ToC) is auto-generated based on the content of heading elements on the page. At the same time, anchor links are auto-generated and added to each heading element. Note that the Material Icons used for the anchor icon make use of ligatures, which means that the icons are specified by using their textual name as text content of the icon element. As a result, the name of the icon is included in the parent element's `textContent`. Previously, the `TocService` used to strip off these anchor elements when generating the content of ToC items, but not when generating the content of their tooltips. Thus, tooltips for ToC items would confusingly include a `link` suffix (`link` is the textual name of the icon used in heading anchor links). This commit fixes this by deriving the tooltip content from the transformed text content (which already has anchor links stripped off), instead of from the original heading content. PR Close angular#32418
sabeersulaiman
pushed a commit
to sabeersulaiman/angular
that referenced
this pull request
Sep 6, 2019
…ular#32418) The docs template for cli commands ([cli-command.template.html][1]) includes an `h2` element with GitHub links for [long description][2]. Since the content of `h2` elements is replicated in the auto-generated Table of Contents, the GitHub links were replicated as well (which is undesirable). This commit fixes it by explicitly excluding `.github-links` elements, when extracting the content for the ToC (in [TocService#extractHeadingSafeHtml()][3]). This is similar to what we do for the auto-generated `.header-link` anchors. [1]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html [2]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html#L18 [3]: https://github.com/angular/angular/blob/1537791f0/aio/src/app/shared/toc.service.ts#L56 PR Close angular#32418
arnehoek
pushed a commit
to arnehoek/angular
that referenced
this pull request
Sep 26, 2019
…ngular#32418) The Table of Contents (ToC) is auto-generated based on the content of heading elements on the page. At the same time, anchor links are auto-generated and added to each heading element. Note that the Material Icons used for the anchor icon make use of ligatures, which means that the icons are specified by using their textual name as text content of the icon element. As a result, the name of the icon is included in the parent element's `textContent`. Previously, the `TocService` used to strip off these anchor elements when generating the content of ToC items, but not when generating the content of their tooltips. Thus, tooltips for ToC items would confusingly include a `link` suffix (`link` is the textual name of the icon used in heading anchor links). This commit fixes this by deriving the tooltip content from the transformed text content (which already has anchor links stripped off), instead of from the original heading content. PR Close angular#32418
arnehoek
pushed a commit
to arnehoek/angular
that referenced
this pull request
Sep 26, 2019
…ular#32418) The docs template for cli commands ([cli-command.template.html][1]) includes an `h2` element with GitHub links for [long description][2]. Since the content of `h2` elements is replicated in the auto-generated Table of Contents, the GitHub links were replicated as well (which is undesirable). This commit fixes it by explicitly excluding `.github-links` elements, when extracting the content for the ToC (in [TocService#extractHeadingSafeHtml()][3]). This is similar to what we do for the auto-generated `.header-link` anchors. [1]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html [2]: https://github.com/angular/angular/blob/1537791f0/aio/tools/transforms/templates/cli/cli-command.template.html#L18 [3]: https://github.com/angular/angular/blob/1537791f0/aio/src/app/shared/toc.service.ts#L56 PR Close angular#32418
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The docs template for cli commands (cli-command.template.html) includes an
h2element with GitHub links for long description. Since the content ofh2elements is replicated in the auto-generated Table of Contents, the GitHub links were replicated as well (which is undesirable).This commit fixes it by explicitly excluding
.github-linkselements, when extracting the content for the ToC (in TocService#extractHeadingSafeHtml()). This is similar to what we do for the auto-generated.header-linkanchors.