Fix overview list and add ID #9156
Closed
Conversation
This file contains hidden or 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
karenzone
approved these changes
Feb 16, 2018
There was a problem hiding this comment.
LGTM. @dedemorton The explanatory notes you're adding are helpful!
elasticsearch-bot
pushed a commit
that referenced
this pull request
Feb 16, 2018
elasticsearch-bot
pushed a commit
that referenced
this pull request
Feb 16, 2018
elasticsearch-bot
pushed a commit
that referenced
this pull request
Feb 16, 2018
elasticsearch-bot
pushed a commit
that referenced
this pull request
Feb 16, 2018
|
Requested redirects here: https://github.com/elastic/website-www.elastic.co/issues/2331 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
After merging these changes, I'll have the web team set up redirects for master and all the 6.x-related branches so that:
https://www.elastic.co/guide/en/logstash/6.0/_configuring_logstash_for_docker.html
redirects to:
https://www.elastic.co/guide/en/logstash/6.0/_configuring_logstash_for_docker/docker-config.html
@karenzone Here's an example where someone added a level 3 heading without specifying an ID. Because no ID is specified, the name of the generated HTML page is based on the heading text. This is bad juju because any changes to the header text will result in the HTML filename changing (bad for SEO and switching between versions on doc pages). Plus, whenever a URL changes, we have to ask the web team to set up redirects, which means extra work for us and them. :-(
The way to avoid this is to make sure all level 3 headings have an ID. Try to look out for this during reviews and point it out so people learn to do it right. :-)