Documentation improvements #179
Merged
Conversation
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
We need to show that there are two spaces after the -d\ for the cut command. Markdown syntax is a bit limited here, so adding the four spaces at the head of this line seems to be the best way right now. Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
| - cd application_root_dir (directory under which subdirectory `src` resides) | ||
| - mkdir tmp; | ||
| - mkdir logs; | ||
| - set permissions for tmp and logs directory | ||
| `` | ||
| - ```HTTPDUSER=`ps aux | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\ -f1```` | ||
| - HTTPDUSER=`ps aux | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\ -f1` |
nijel
Mar 5, 2018
Member
IMHO this will look wrong - it should be rendered as
HTTPDUSER=`ps aux...`
Not as
HTTPDUSER=ps aux...
(The latter one is missing backticks around the statement)
IMHO this will look wrong - it should be rendered as
HTTPDUSER=`ps aux...`
Not as
HTTPDUSER=ps aux...
(The latter one is missing backticks around the statement)
ibennetch
Mar 5, 2018
Author
Member
I believe it's rendered correctly through GitHub markdown, I've tested at https://github.com/ibennetch/test/wiki/Bullet-point-commands
It's still a little ugly, and it's not rendered quite the same as the backtick-markdown, but I don't know another way to show both spaces after the backslash (without both spaces the cut command fails).
I believe it's rendered correctly through GitHub markdown, I've tested at https://github.com/ibennetch/test/wiki/Bullet-point-commands
It's still a little ugly, and it's not rendered quite the same as the backtick-markdown, but I don't know another way to show both spaces after the backslash (without both spaces the cut command fails).
nijel
Mar 5, 2018
Member
Okay, you're right it seems correct (but still a confusing syntax).
Okay, you're right it seems correct (but still a confusing syntax).
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.
I've tried to make some improvements to the installation instructions. Please let me know what you think.