magento/devdocs#: Editing. Add bash syntax to command line #4274

atwixfirster · 2019-04-17T19:03:02Z

Purpose of this PR

This PR adds bash syntax to command line examples.

Affected URLs

Thank you!

devops-devdocs · 2019-04-17T19:05:04Z

An admin must run tests on this PR before it can be merged.

dobooth · 2019-04-17T19:16:32Z

Nice.
A couple things:
If you have two+ commands in a row, they each get their own bash block, separated by a space of course. This ensures that the $ is added at the start of each line. Second: you can remove empty lines just after the bash.
Third: some of these code blocks are heavily indented. Pull them in where you can.
I didn't leave a comment on every instance, just as examples.

dobooth · 2019-04-17T19:19:42Z

guides/v2.1/cloud/cdn/configure-fastly.md

 	* In the "repositories" section, you should have:
-
+```json
 		"fastly-magento2": {


Pull in indenting in things like this.

dobooth · 2019-04-17T19:20:18Z

guides/v2.1/cloud/howtos/sample-data.md

-		git push origin <branch name>
+```bash
+git add -A && git commit -m "Install sample data"
+git push origin <branch name>


Each gets its own ```bash block.

dobooth · 2019-04-17T19:21:05Z

guides/v2.1/cloud/live/sens-data-initial.md


 The following snippet from `config.local.php` shows an example of changing the default locale to `en_GB` and changing static file optimization settings:

+```php


The PRE tags are the old highlighting code. It should be removed.

Wrap the code in a php block, and place this line immediately below the block
{: .no-copy }

dobooth · 2019-04-17T19:21:33Z

guides/v2.1/cloud/live/sens-data-initial.md

 The following command adds, commits, and pushes to master:

-	git add app/etc/config.local.php && git commit -m "Add system-specific configuration" && git push origin master
+```bash


Remove blank line below and on the others.

dobooth · 2019-04-17T19:23:30Z

guides/v2.1/comp-mgr/trouble/cman/ce-ee-upgrade.md


-		php <your Magento install dir>/bin/magento setup:upgrade
+```bash
+php <your Magento install dir>/bin/magento setup:upgrade


Use <magento_root>

Use <magento_root>

done

dobooth · 2019-04-17T20:02:45Z

guides/v2.1/cloud/cdn/configure-fastly.md


-		php bin/magento setup:upgrade && php bin/magento cache:clean
+```bash
+php bin/magento setup:upgrade && php bin/magento cache:clean


The convention is just bin/magento command...
You can remove the php from all these commands.

The convention is just bin/magento command...
You can remove the php from all these commands.

implemented

The blanket PHP changes made can not apply to Cloud documentation. Some of those affect sample code for copy to YAML files and will cause errors without the "PHP". Please revert changes to Cloud documentation for PHP command.

The blanket PHP changes made can not apply to Cloud documentation. Some of those affect sample code for copy to YAML files and will cause errors without the "PHP". Please revert changes to Cloud documentation for PHP command.

reverted for Cloud documentation

keharper · 2019-04-17T20:10:50Z

guides/v2.1/cloud/cdn/configure-fastly.md


-		git add -A; git commit -m "Install Fastly"; git push origin <branch name>
+```bash
+git add -A; git commit -m "Install Fastly"; git push origin <branch name>


Would && be better here than ;?

Would && be better here than ;?

implemented

rogyar · 2019-04-18T08:33:12Z

guides/v2.2/config-guide/cli/config-cli-subcommands-cache.md


 Sample result:

+```terminal


Is terminal a correct alias for syntax highlight? I'm unable to find it in the linguist reference which is used by Github.
Maybe we should use bash in such cases as well?

We use bash for commands because the CSS adds the $ to the line but it is not included when copying.
terminal will work and it is used to show the output/results of a command. It will not include the $ at the start of the line.

hguthrie

For all Cloud topics: Code blocks inside of steps need a 4-space indention with a blank line before and after the code block.

1. Replace <your Magento install dir> with <magento_root> regarding Donald Booth comment

1. Replace "php bin/magento" with "bin/magento" regarding Donald Booth comment

atwixfirster · 2019-04-19T22:00:28Z

For all Cloud topics: Code blocks inside of steps need a 4-space indention with a blank line before and after the code block.

implemented

Thank you, @hguthrie !

hguthrie · 2019-04-19T22:06:47Z

guides/v2.1/cloud/configure/setup-cron-jobs.md

    cronrun:
        spec: "* * * * *"
-        cmd: "php bin/magento cron:run"
+        cmd: "bin/magento cron:run"


These are YAML file snippets and need the PHP

These are YAML file snippets and need the PHP

reverted

hguthrie · 2019-04-19T22:08:36Z

guides/v2.1/cloud/project/project-conf-files_magento-app.md

    cronrun:
        spec: "* * * * *"
-        cmd: "php bin/magento cron:run"
+        cmd: "bin/magento cron:run"


This PHP belongs in the YAML snippet

hguthrie · 2019-04-19T22:11:57Z

guides/v2.1/cloud/project/project-upgrade.md


    ```bash
-      php bin/magento --version
+      bin/magento --version


tested in Cloud, either way works

hguthrie · 2019-04-19T22:12:31Z

guides/v2.1/cloud/release-notes/CloudReleaseNotes101.7.md

 ### 101.7.3 changes

-<!--- MAGECLOUD-782 -->* Magento no longer throws an error when only the default store issued.  Previously, when only the default store is used, Magento threw the following error when running `php bin/magento magento-cloud:scd-dump`:
+<!--- MAGECLOUD-782 -->* Magento no longer throws an error when only the default store issued.  Previously, when only the default store is used, Magento threw the following error when running `bin/magento magento-cloud:scd-dump`:


I wouldn't change old release notes.

I wouldn't change old release notes.

ok. Reverted 😊

atwixfirster · 2019-04-19T22:46:45Z

Nice.
A couple things:
If you have two+ commands in a row, they each get their own bash block, separated by a space of course. This ensures that the $ is added at the start of each line. Second: you can remove empty lines just after the bash.
Third: some of these code blocks are heavily indented. Pull them in where you can.
I didn't leave a comment on every instance, just as examples.

done

hguthrie

Cloud changes approved at this time.

jcalcaben · 2019-04-30T16:22:22Z

@dobooth is there an update for this?

Merge remote-tracking branch 'upstream/master' into format-bash # Conflicts: # guides/v2.1/architecture/security_intro.md # guides/v2.2/cloud/configure/setup-b2b.md

…into format-bash

atwixfirster · 2019-05-02T16:04:19Z

@dobooth , could you please approve this PR ;)

Many thanks!

dobooth · 2019-05-06T14:41:52Z

Oh sorry! Missed it.

dobooth · 2019-05-06T14:42:44Z

running tests

ghost · 2019-05-06T15:10:22Z

Hi @atwixfirster, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

magento-engcom-team added Partner: Atwix partners-contribution PR created by Magento partner labels Apr 17, 2019

rogyar self-assigned this Apr 17, 2019

dobooth suggested changes Apr 17, 2019

View reviewed changes

keharper reviewed Apr 17, 2019

View reviewed changes

rogyar suggested changes Apr 18, 2019

View reviewed changes

hguthrie suggested changes Apr 19, 2019

View reviewed changes

atwixfirster added 3 commits April 20, 2019 00:23

magento/devdocs#: Format Bash

a2e058e

1. Replace <your Magento install dir> with <magento_root> regarding Donald Booth comment

magento/devdocs#: Format Bash

cc7f5ad

1. Replace "php bin/magento" with "bin/magento" regarding Donald Booth comment

magento/devdocs#: Format Bash

48db08f

hguthrie reviewed Apr 19, 2019

View reviewed changes

atwixfirster added 3 commits April 20, 2019 01:16

magento/devdocs#: Format Bash

7c65dae

magento/devdocs#: Format Bash

8684ef7

magento/devdocs#: Format Bash

70d75b1

atwixfirster added 5 commits April 20, 2019 01:53

magento/devdocs#: Format Bash

90663b3

magento/devdocs#: Format Bash

5e825b2

magento/devdocs#: Format Bash

90ca93a

magento/devdocs#: Format Bash

b06b24e

magento/devdocs#: Format Bash

10c19c1

hguthrie approved these changes Apr 22, 2019

View reviewed changes

Fixed formatting.

3f7042d

dobooth added 6 commits April 22, 2019 13:07

Fixed highlighter.

6ccbaaf

Fixed command.

fb0e532

Removed tabs.

5df7a6d

Fixed code blocks.

9a03c49

Formatting.

c8e4bcd

Fixed code block.

25a0964

rogyar approved these changes Apr 23, 2019

View reviewed changes

osrecio self-requested a review April 23, 2019 08:59

osrecio approved these changes Apr 23, 2019

View reviewed changes

atwixfirster added 2 commits May 2, 2019 19:00

magento/devdocs#: Format Bash

57b9eef

Merge remote-tracking branch 'upstream/master' into format-bash # Conflicts: # guides/v2.1/architecture/security_intro.md # guides/v2.2/cloud/configure/setup-b2b.md

Merge branch 'format-bash' of https://github.com/atwixfirster/devdocs …

d33d578

…into format-bash

Merge branch 'master' into format-bash

5d2008b

dobooth approved these changes May 6, 2019

View reviewed changes

osrecio self-assigned this May 6, 2019

dobooth merged commit 93604e2 into magento:master May 6, 2019

atwixfirster mentioned this pull request May 9, 2019

magento/devdocs#: Replace <your Magento install dir> with <magento_root> #4469

Merged

keharper mentioned this pull request May 29, 2019

Update php magento command #4615

Closed

jeff-matthews mentioned this pull request May 29, 2019

bin/magento this is the preferred standardized style for Magento CLI commands #4626

Closed


		The following snippet from `config.local.php` shows an example of changing the default locale to `en_GB` and changing static file optimization settings:

		```php

magento/devdocs#: Editing. Add bash syntax to command line #4274

magento/devdocs#: Editing. Add bash syntax to command line #4274

Uh oh!

Conversation

atwixfirster commented Apr 17, 2019

Purpose of this PR

Affected URLs

Uh oh!

devops-devdocs commented Apr 17, 2019

Uh oh!

dobooth commented Apr 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dobooth Apr 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hguthrie left a comment

Choose a reason for hiding this comment

Uh oh!

atwixfirster commented Apr 19, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

atwixfirster commented Apr 19, 2019

Uh oh!

hguthrie left a comment

Choose a reason for hiding this comment

Uh oh!

jcalcaben commented Apr 30, 2019

dobooth commented Apr 17, 2019 •

edited

Loading

dobooth Apr 17, 2019 •

edited

Loading