This repository was archived by the owner on Oct 14, 2020. It is now read-only.
Improve developer guide #28
Merged
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
J12934
approved these changes
Jun 23, 2020
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
- Move the documentation as comments in fenced code blocks up as toplevel text for better readability. - Use code (backtick) markup for stuff used as keyboard input and filenames. - Remove leading $ in bash example because this prevents copy paste of the examle code w/o manual editing. - Make single paragraph text also a single line w/o unnecessary linebreaks. Just use an editor with line wrapping. - Some spell checking. - Markdown allows only one H1 equivalent top level title Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com> Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
There are some rules around how to case titles in English. I justed used the default of tcc[1]: Chicago Manual of Style. 1: https://github.com/nickjj/title-case-converter Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
- Add a macosOS section with Homebrew. - Linebreak long commands. - Change the export: We can just use localhost. - Add hint about direnv. - Clarify instructions about uninstalling the operator. Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
This enables a per direcotry configuration which does not mangle up with other projects using S3. Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
It is cumbersome to copy paste the snippets always from the README. Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
nigthknight
reviewed
Jun 24, 2020
For the sake of consistency we also upgrade install the operator instead of only installing it. Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
nigthknight
approved these changes
Jun 24, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
No description provided.