Skip to content

docs: add package ID prefix to h3's ids #17527

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

Merged
merged 1 commit into from
Oct 28, 2019
Merged

Conversation

andrewseguin
Copy link
Contributor

This helps avoid collisions in the table of content's sections like
"Directives" and "Services", since now we may show more than one
package entry point in docs (e.g. button and button-testing).

Note that we chose not to add the prefix to individual
class/constant/interface/etc names because it muddles the URL and
is unlikely that we collide on these values.

e.g

<h3 id="material-button-directives" class="docs-header-link docs-api-h3">
<h3 id="material-button-testing-interfaces" class="docs-header-link docs-api-h3">

Fixes #17526

This helps avoid collisions in the table of content's sections like
"Directives" and "Services", since now we may show more than one
package entry point in docs (e.g. button and button-testing).

Note that we chose not to add the prefix to individual
class/constant/interface/etc names because it muddles the URL and
is unlikely that we collide on these values.
@andrewseguin andrewseguin requested a review from a team as a code owner October 28, 2019 18:25
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Oct 28, 2019
@andrewseguin andrewseguin added P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful pr: merge safe and removed cla: yes PR author has agreed to Google's Contributor License Agreement labels Oct 28, 2019
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Oct 28, 2019
@mmalerba mmalerba added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Oct 28, 2019
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn added the target: major This PR is targeted for the next major release label Oct 28, 2019
@mmalerba mmalerba merged commit d3fd8b3 into angular:master Oct 28, 2019
@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 Nov 28, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement P1 Impacts a large percentage of users; if a workaround exists it is partial or overly painful target: major This PR is targeted for the next major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs content needs to prefix HTML ids with the package name
4 participants