Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

docs: properly format anchor names and hrefs #11648

Merged
merged 1 commit into from
Feb 23, 2019
Merged

docs: properly format anchor names and hrefs #11648

merged 1 commit into from
Feb 23, 2019

Conversation

Splaktar
Copy link
Member

@Splaktar Splaktar commented Feb 21, 2019 •
edited
Loading

PR Checklist

Please check that your PR fulfills the following requirements:

  • The commit message follows our guidelines
  • Tests for the changes have been added or this is not a bug fix / enhancement
  • Docs have been added, updated, or were not required

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Enhancement
[ ] Documentation content changes
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

  • Anchor names include a # or path which breaks them
  • Anchor hrefs don't include the baseURL which sends them to 404 pages

Issue Number:
Fixes #11644. Relates to #11634. Relates to #11285.

What is the new behavior?

  • anchor names do not include any path info
  • hrefs include the baseURL in addition to the path

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@Splaktar
docs: properly format anchor names and hrefs
e9ca928 
anchor names should not include any path info
hrefs need to include the baseURL in addition to the path

Fixes #11644. Relates to #11634. Relates to #11285.
@Splaktar Splaktar added type: docs P2: required Issues that must be fixed. labels Feb 21, 2019
@Splaktar Splaktar added this to the 1.1.14 milestone Feb 21, 2019
@Splaktar Splaktar self-assigned this Feb 21, 2019
@googlebot googlebot added the cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ label Feb 21, 2019
@Splaktar Splaktar added pr: merge ready This PR is ready for a caretaker to review pr: merge safe labels Feb 21, 2019
jelbourn
jelbourn approved these changes Feb 23, 2019
View reviewed changes
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 merged commit 163b762 into master Feb 23, 2019
@Splaktar Splaktar deleted the docs-fixAnchorNames branch February 23, 2019 00:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jelbourn jelbourn jelbourn approved these changes

Assignees

@jelbourn jelbourn

@Splaktar Splaktar

Labels
cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ P2: required Issues that must be fixed. pr: merge ready This PR is ready for a caretaker to review type: docs
Projects
None yet
Milestone
1.1.14
Development

Successfully merging this pull request may close these issues.

bug(docs) relative anchor links not working in docs
3 participants
@Splaktar @jelbourn @googlebot