[docs] README fixes #2123
Merged
[docs] README fixes #2123
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
added 6 commits
August 22, 2019 01:38
The path to generated grammar and diagram Markdown files is incorrect. Rather than `syntax_resources`, it should be `syntax_resources/commands`. Fix this in `docs/README.md`. Also make minor changes around the area.
There is a note indicating that the examples following it are based on a certain working directory and target file. However, many of the things following it are not based on that working directory, and the target file is reintroduced each time. This makes this note useless, if not misleading. Remove it.
The current `README.md` refers to `config.yaml.sample` when it should be `config.yaml.example`. Fix these references.
`git add -A` should not be promoted in any sort of instructions because uncareful people may accidentally commit unrelated files. Generalize the instructions to `git add ...` because there are plenty of other ways to add files to the index.
The docs repository is no longer active as it got merged into the main yugabyte-db repository. Fix any references to the old docs repo, and make minor fixes in the surrounding area.
The docs README suggests to use the master branch for pull requests. That is not recommended practice. Add a suggestion to create a feature branch.
|
|
|
Can one of the admins verify this patch? |
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.
Some minor edits to the docs README. Mainly updating
outdated references.