New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements #179

Merged
merged 5 commits into from Mar 5, 2018

Conversation

Projects
None yet
2 participants
@ibennetch
Member

ibennetch commented Mar 4, 2018

I've tried to make some improvements to the installation instructions. Please let me know what you think.

ibennetch added some commits Mar 3, 2018

Update Apache directives for version 2.4
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Add note about installing composer
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Update Debian package name to metapackage
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Add section about Apache configuration overriding an existing setup
Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
Fix up Markdown syntax.
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`

This comment has been minimized.

@nijel

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)

This comment has been minimized.

@ibennetch

ibennetch Mar 5, 2018

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).

This comment has been minimized.

@nijel

nijel Mar 5, 2018

Member

Okay, you're right it seems correct (but still a confusing syntax).

@nijel nijel merged commit e61b7ed into phpmyadmin:master Mar 5, 2018

2 of 3 checks passed

continuous-integration/travis-ci/pr The Travis CI build failed
Details
Codacy/PR Quality Review Good work! A positive pull request.
Details
Scrutinizer No new issues
Details

@nijel nijel self-assigned this Mar 5, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment