minor formatting for README files #48
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
johnkim76
changed the title
johnkim76
changed the title
jmrodri
requested changes
May 23, 2017
ec2/README.md
Outdated
| @@ -30,7 +30,7 @@ These playbooks will: | |||
| $ python -c "import ansible;print(ansible.__version__)" | |||
| 2.2.2.0 | |||
| * Install python dependencies (This is needed for python2. Use pip2 if using python3) | |||
| * `pip install boto boto3 six` | |||
| $ pip install boto boto3 six | |||
There was a problem hiding this comment.
This needs to be marked with ``` you can't see it in the formatted view.
- Install python dependencies (...)
$ pip install boto boto3 six
something like that
ec2/README.md
Outdated
| $ ./run_create_infrastructure.sh | ||
| * Run the setup script | ||
| $ ./run_setup_environment.sh | ||
| * Open a Web Browser |
There was a problem hiding this comment.
You're adding a newline to try to make it easier to read, but it doesn't work. It just ends up being on the same line. I would make all the commands escaped with triple tick marks ```
| * Accept the SSL certificate for the apiserver-service-catalog endpoint | ||
| * Ignore the text that appears and proceed to the main OpenShift URL next | ||
| * Note: must accept the new SSL cert, each time you reset your OpenShift environment | ||
| * Visit: `https://<USERNAME>.ec2.dog8code.com:8443` |
local/README.md
Outdated
| * `cd local` | ||
| * `./reset_environment.sh` | ||
| * To reset the environment to a clean instance of origin with ASB and Service Catalog run the below | ||
| $ ./reset_environment.sh |
There was a problem hiding this comment.
Again, these commands get butted to the end of the sentences and you can't really see they are commands that need executing.
encapsulate shell commands and examples with a ```
|
@jmrodri thank you. I've made the changes you suggested. |
jmrodri
approved these changes
May 26, 2017
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.
No description provided.