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.

Sign up for GitHub

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

Jump to bottom

build(aio): prevent API H1 anchor showing in Table of Contents #22437

Closed
wants to merge 1 commit into from
Closed

build(aio): prevent API H1 anchor showing in Table of Contents #22437

wants to merge 1 commit into from

Conversation

petebacondarwin
Copy link
Member

Closes #22387

@petebacondarwin petebacondarwin added action: review The PR is still awaiting reviews from at least one requested reviewer comp: aio target: major This PR is targeted for the next major release labels Feb 25, 2018
@petebacondarwin petebacondarwin added this to REVIEW in docs-infra Feb 25, 2018
@mary-poppins
Copy link

You can preview a6a4025 at https://pr22437-a6a4025.ngbuilds.io/.

@gkalpak gkalpak added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Feb 25, 2018
@petebacondarwin
Copy link
Member Author

By the way this is really a workaround because I could understand why dgeni or something was adding an extra <a> tag in front of the real anchor.

@gkalpak
Copy link
Member

gkalpak commented Feb 25, 2018

Oh, so this also removes the header-link on the main page's <h1> element. I didn't realize that :)

@petebacondarwin
Copy link
Member Author

Yes but I decided that people rarely need to link to the top heading - and the ToC link still works anyway. So for "getting on with things" reasons I just went with the workaround.

@petebacondarwin petebacondarwin moved this from REVIEW to MERGE in docs-infra Feb 25, 2018
gkalpak added a commit to gkalpak/angular that referenced this pull request Feb 25, 2018
@gkalpak
build(aio): fix API docs breadcrumbs
fd4f917 
This also prevents some extra `<a>` elements inserted by the browser's
trying to fix the HTML structure, which also fixes the `.header-link`
added in ToC.

Fixes angular#22387
Closes angular#22437
@gkalpak gkalpak mentioned this pull request Feb 25, 2018
Closed
@gkalpak
Copy link
Member

gkalpak commented Feb 25, 2018 •
edited

#22446 should fix the ToC .header-link.
This PR might still be a viable partial fix for #22131.

@petebacondarwin
Copy link
Member Author

Thanks for the better fix for this. I think that repositioning the heading anchor will be a better fix across the board for #22131

@petebacondarwin petebacondarwin removed this from MERGE in docs-infra Feb 26, 2018
petebacondarwin pushed a commit to petebacondarwin/angular that referenced this pull request Feb 26, 2018
@gkalpak @petebacondarwin
build(aio): fix API docs breadcrumbs
598f37f 
This also prevents some extra `<a>` elements inserted by the browser's
trying to fix the HTML structure, which also fixes the `.header-link`
added in ToC.

Fixes angular#22387
Closes angular#22437
@petebacondarwin petebacondarwin deleted the aio-api-h1-anchor branch February 27, 2018 09:38
petebacondarwin pushed a commit to petebacondarwin/angular that referenced this pull request Feb 27, 2018
@gkalpak @petebacondarwin
build(aio): fix API docs breadcrumbs
de72a46 
This also prevents some extra `<a>` elements inserted by the browser's
trying to fix the HTML structure, which also fixes the `.header-link`
added in ToC.

Fixes angular#22387
Closes angular#22437
alexeagle pushed a commit that referenced this pull request Feb 27, 2018
@gkalpak @alexeagle
build(aio): fix API docs breadcrumbs (#22446)
d100f1b 
This also prevents some extra `<a>` elements inserted by the browser's
trying to fix the HTML structure, which also fixes the `.header-link`
added in ToC.

Fixes #22387
Closes #22437

PR Close #22446
smdunn pushed a commit to smdunn/angular that referenced this pull request Feb 28, 2018
@gkalpak @smdunn809
build(aio): fix API docs breadcrumbs (angular#22446)
318aeeb 
This also prevents some extra `<a>` elements inserted by the browser's
trying to fix the HTML structure, which also fixes the `.header-link`
added in ToC.

Fixes angular#22387
Closes angular#22437

PR Close angular#22446
leo6104 pushed a commit to leo6104/angular that referenced this pull request Mar 25, 2018
@gkalpak @leo6104
build(aio): fix API docs breadcrumbs (angular#22446)
cb24f91 
This also prevents some extra `<a>` elements inserted by the browser's
trying to fix the HTML structure, which also fixes the `.header-link`
added in ToC.

Fixes angular#22387
Closes angular#22437

PR Close angular#22446
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@gkalpak gkalpak gkalpak approved these changes

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker cla: yes target: major This PR is targeted for the next major release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

aio + docs/api: Table of Contents renders a heading link icon
4 participants
@petebacondarwin @mary-poppins @gkalpak @googlebot