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

Summarize|Surface HTML ID tags so that readers may grab them to use as references #489

Closed
DazWilkin opened this issue May 10, 2016 · 1 comment

Comments

@DazWilkin
Copy link

Surface HTML ID tags so that readers may grab them to use as references.

E.g.
/docs/user-guide/namespaces/

Rather than "Go to this page and scroll down to 'Namespace and DNS'
Enable "Click this link to go to 'Namespace and DNS'"

The page contains multiple ID references but these aren't surfaced to the reader of the page once rendered:

/docs/user-guide/namespaces/#setting-the-namespace-for-a-request
/docs/user-guide/namespaces/#setting-the-namespace-preference
/docs/user-guide/namespaces/#namespaces-and-dns
etc.

Recommend:

  1. Each page should summarize (ToC) these links (so the hyperlinks could be grabbed)
  2. Each ID should be annotated with a bookmark for the reader to grab the specific anchor
@jaredbhatti
Copy link
Contributor

Agreed. We now have a travis check that requires a TOC, and TOC entries have anchors.

mikutas pushed a commit to mikutas/k8s-website that referenced this issue Feb 24, 2021
* Fix install-helm page

Code snippets didn't look fine after removing the wrapping empty lines.
Trying one more time.

Followup to kubernetes#486

Signed-off-by: Alejandro Pedraza Borrero <alejandro@buoyant.io>

* Linter won't let me fix the OL

Signed-off-by: Alejandro Pedraza Borrero <alejandro@buoyant.io>

* Actually let's try disabling that lint

Signed-off-by: Alejandro Pedraza Borrero <alejandro@buoyant.io>
serathius pushed a commit to serathius/website that referenced this issue Mar 16, 2022
Okabe-Junya pushed a commit to Okabe-Junya/website that referenced this issue Dec 4, 2023
Update dev-zh branch with main branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants