Fix RST syntax and formatting repo-wide #124
Merged
Conversation
This file contains 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
ReStructuredText features different ways of creating internal links: * `:ref:` allows you to reference any location in the project. To use it, you have to add markup at the destination. * `:doc:` allows you to reference any document in the project. It links to the top of the page of the specified document, but requires no additional markup. Virtually every use of `:ref:` was just a link to another page (document), and not a specific location/section of a page. Thus, there was lots of unnecessary reference-point markup littered throughout the project (e.g., a `.. _install-elasticsearch:` line at the top of `/install/elasticsearch.rst`). This commit removes those lines. It also removes a largely redundant meta-table-of-contents on the front page of the docs.
MrGeneration
approved these changes
Jan 20, 2020
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.
This is a follow-up to PR #123, applying some RST syntax/formatting fixes from that PR across the rest of the codebase. I also got carried away and edited an article or two for readability and appearance.
These changes are not strictly necessary, but they establish cleaner patterns across the codebase for new authors to follow.