mautic / documentation

Mautic End User Documentation
Apache License 2.0
62 stars 141 forks source link

Improve getting started #325

Closed RCheesley closed 5 years ago

RCheesley commented 5 years ago

Adding more information and screenshots to getting started documentation

RCheesley commented 5 years ago

This seems to have pulled in a PR that I made to my fork from master to update my fork ... not sure how to remove that! :blush:

aspiers commented 5 years ago

@RCheesley Assuming you have the official mautic repo set up as a git remote called upstream and your own github fork as a remote called mine, this should work:

git rebase upstream/master improve-getting-started
git push -f mine improve-getting-started

However depending on how you set it up, probably one of those remotes is actually called origin and the other will be called something else, so amend the above commands accordingly.

I am a former git developer and have also done an unhealthy amount of work with GitHub, so you are very welcome to ping me if you ever get stuck with this kind of stuff - I'd be glad to help.

RCheesley commented 5 years ago

Thanks for all the suggestions! Learning so much!

On Mon, 2 Sep 2019 at 10:38, Adam Spiers notifications@github.com wrote:

@aspiers commented on this pull request.

In en/setup/getting_started.md https://github.com/mautic/documentation/pull/325#discussion_r319882205:

+

+

+

+the problem is likely to be due to the permissions on your files and folders.

+

+If you have access to the command line, you can run the following commands to reset the file and folder permissions. Make sure that you are in the directory where Mautic has been installed (using the example above, that would mean executing these commands within /m in your web root folder - you can get there using the cd command)

+

+```find . -type d -exec chmod 755 {} \;

+find . -type f -exec chmod 644 {} \;

+chmod -R g+w app/cache/

+chmod -R g+w app/logs/

+chmod -R g+w app/config/

+chmod -R g+w media/files/

+chmod -R g+w media/images/

+chmod -R g+w translations/

+chown -R $USER:www-data .```

For this kind of code block, I would suggest avoiding use of triple backticks and instead simply indenting the whole thing by 4 columns:

This is some normal text.

find . -type f -exec chmod 644 {} \;

chmod -R g+w app/cache/

and normal text again.

This will achieve exactly the same rendering effect, but has the advantage of making the non-rendered plain-text file much more readable. This adheres to Markdown's original design goal, as stated on the homepage https://daringfireball.net/projects/markdown/:

The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible.

However, if you do use triple backticks, bear in mind the following:

  • Any text immediately following the opening backticks on the first line is used by GitHub to indicate the coding language of the rest of the block, so that it can syntax highlight correctly https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown
  • For single-line code blocks, single backticks are sufficient. Triple backticks are only needed when the content contains backticks of its own.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/mautic/documentation/pull/325?email_source=notifications&email_token=AAWLPIMALSQRLWPLEG3ODJ3QHTNJFA5CNFSM4ISXSK2KYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCDLJDAI#pullrequestreview-282497409, or mute the thread https://github.com/notifications/unsubscribe-auth/AAWLPIJOROEXYNBVQU2PSZLQHTNJFANCNFSM4ISXSK2A .

virgilwashere commented 5 years ago

⚠️ PR #361 replaces this.