Skip to content

Commit

Permalink
Fix code block style (MD040) (magento#5428)
Browse files Browse the repository at this point in the history
* Fixed a few issues in random topics

* Fixed README

* Fixed config cli subcommands topics

* Turn off MD040

* Replaced terminal lexer with text
  • Loading branch information
jeff-matthews authored Sep 20, 2019
1 parent 0bcf68a commit 5a04023
Show file tree
Hide file tree
Showing 28 changed files with 829 additions and 631 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For local builds, you need to install Ruby 2.4 or later.
To check the Ruby version on your environment, run in your terminal:

```shell
$ ruby -v
ruby -v
```

### Install the latest Ruby (if the Ruby version is less than 2.4)
Expand All @@ -33,8 +33,8 @@ $ ruby -v
1. Install Homebrew. See the [Homebrew site](https://brew.sh) for instructions.
1. Use Homebrew to install the latest stable version of Ruby:

```
$ brew install ruby
```bash
brew install ruby
```

**Unix, Windows, and other OS users**
Expand All @@ -45,8 +45,8 @@ See the [Ruby site](https://www.ruby-lang.org/en/documentation/installation) for

Upgrade [RubyGems](https://github.com/rubygems/rubygems), which helps with dependencies (gems):

```
$ gem update --system
```bash
gem update --system
```

Once you have completed preparing your environment, you can build locally and review the site in your browser.
Expand All @@ -55,8 +55,8 @@ Once you have completed preparing your environment, you can build locally and re

Clone or download the repository. The first time you are at the `devdocs` directory, run:

```
$ bundle install
```bash
bundle install
```

Once you have completed preparing your environment, you can build locally and review the site in your browser.
Expand All @@ -69,8 +69,8 @@ Once you have completed preparing your environment, you can build locally and re

1. Run the rake task that installs all required dependencies and starts the [Jekyll](https://jekyllrb.com/) server:

```
$ rake preview
```bash
rake preview
```

1. Press `Ctrl+C` in the serve terminal to stop the server.
Expand All @@ -81,14 +81,14 @@ If rake fails on your environment, generate the preview [using jekyll](#using-je

1. The first time you are at the `devdocs` directory or when you need to pick up changes in `Gemfile.lock` dependencies (for example, theme changes), run:

```
$ bundle install
```bash
bundle install
```

1. To generate the local preview, run:

```
$ bundle exec jekyll serve --incremental
```bash
bundle exec jekyll serve --incremental

Configuration file: /Users/username/Github/devdocs/_config.yml
Source: /Users/username/Github/devdocs
Expand Down Expand Up @@ -136,8 +136,8 @@ If rake fails on your environment, generate the preview [using jekyll](#using-je
1. Run the preview command:
```
$ rake preview
```bash
rake preview
```

This command:
Expand Down Expand Up @@ -170,13 +170,13 @@ To build v2.0 documentation:
1. Initialize the `2.0` branch in your local devdocs repository.

```shell
```bash
rake init
```

1. Run the preview command.

```shell
```bash
rake preview
```

Expand All @@ -202,13 +202,13 @@ To build v2.1 documentation:

1. Initialize the `2.1` branch in your local devdocs repository.

```shell
```bash
rake init
```

1. Run the preview command.

```shell
```bash
rake preview
```

Expand Down
8 changes: 4 additions & 4 deletions _videos/fundamentals/add-a-new-table-to-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ You should see a long list of modules that contain `Learning_GreetingMessage`.

Connect to the database: `mysql -u<user> -p<password> <database>`.

```
```terminal
SHOW TABLES LIKE “%greeting%”
+------------------------------------+
Expand All @@ -248,7 +248,7 @@ When you create a new module and run the `bin/magento setup:upgrade` script, Mag
If it finds any, it checks whether there are any install scripts and if so, runs them.
Magento then updates the table `setup_module` and puts information about the module and its version there:

```
```terminal
SELECT * FROM setup_module WHERE module='Learning_GreetingMessage';
+--------------------------+----------------+--------------+
Expand All @@ -268,7 +268,7 @@ To see how the upgrade scripts work, we’ll add some data to the database.

First, change the version in the `etc/module.xml` file to 0.0.2:

```
```xml
<module name="Learning_GreetingMessage" setup_version="0.0.2">
```

Expand Down Expand Up @@ -385,7 +385,7 @@ php bin/magento setup:upgrade

We can now connect to the database and verify that our changes are there:

```
```terminal
select * from greeting_message;
+-------------+--------------------+--------+
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/advanced-reporting/report-xml.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Columns are added using the `<attribute>` node.

All report files are located in the `etc` directory of a module:

```
```text
<module_dir>/etc/reports.xml
```

Expand Down
6 changes: 3 additions & 3 deletions guides/v2.2/b2b/company-structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Company teams allow you to group company users by location, job responsibilities

**REST Endpoints**

```
```terminal
POST /V1/team/:companyId
PUT /V1/team/:teamId
GET /V1/team/:teamId
Expand Down Expand Up @@ -181,7 +181,7 @@ You can use REST endpoints to retrieve the current structure and move teams and

**REST Endpoints**

```
```terminal
GET /V1/hierarchy/:id
PUT /V1/hierarchy/move/:id
```
Expand All @@ -190,7 +190,7 @@ PUT /V1/hierarchy/move/:id

In the following example, the following company hierarchy has already been established:

```
```terminal
Admin (structure_id = 2)
|-- East (team, structure_id = 8)
| |-- Bryce Martin (customer, structure_id = 4)
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/b2b/company-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This section describes the REST endpoints used to manage company users.

**REST Endpoints**

```
```terminal
POST /V1/customers/
PUT /V1/customers/:customerId
```
Expand Down
4 changes: 2 additions & 2 deletions guides/v2.2/b2b/credit-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ When you create a company, the credit limit is set to 0. Use the `PUT /V1/compan

**REST Endpoints**

```
```terminal
PUT /V1/companyCredits/:id
GET /V1/companyCredits/:creditId
GET /V1/companyCredits/company/:companyId
Expand Down Expand Up @@ -217,7 +217,7 @@ The company's outstanding balance can be updated as the buyer makes payments, pu

**REST Endpoints**

```
```terminal
POST /V1/companyCredits/:creditId/decreaseBalance
POST /V1/companyCredits/:creditId/increaseBalance
```
Expand Down
Loading

0 comments on commit 5a04023

Please sign in to comment.