Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Markdown linting: Enable rule MD036 (emphasis used instead of a header) #6023

Merged
merged 5 commits into from
Nov 18, 2019
Merged

Markdown linting: Enable rule MD036 (emphasis used instead of a header) #6023

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5e155eb
Added colons to common psuedo-headers
jeff-matthews Nov 18, 2019
7b317cf
Added colons to less common psuedo headers
jeff-matthews Nov 18, 2019
27d0457
Added colons to more less common psuedo headers
jeff-matthews Nov 18, 2019
e913858
Removed emphasis from captions
jeff-matthews Nov 18, 2019
1e91441
Merge branch 'master' into 5251-enable-rule-MD036
jeff-matthews Nov 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ ruby -v

### Install the latest Ruby (if the Ruby version is less than 2.4)

**MacOS users**
**MacOS users:**

1. Install Homebrew. See the [Homebrew site](https://brew.sh) for instructions.
1. Use Homebrew to install the latest stable version of Ruby:
Expand All @@ -37,7 +37,7 @@ ruby -v
brew install ruby
```

**Unix, Windows, and other OS users**
**Unix, Windows, and other OS users:**

See the [Ruby site](https://www.ruby-lang.org/en/documentation/installation) for instructions.

Expand Down
2 changes: 1 addition & 1 deletion _checks/styles/style-rules-prod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ rule 'MD032'
exclude_rule 'MD033'
exclude_rule 'MD034'
rule 'MD035'
exclude_rule 'MD036'
rule 'MD036'
rule 'MD037'
rule 'MD038'
exclude_rule 'MD039'
Expand Down
36 changes: 18 additions & 18 deletions guides/v2.2/b2b/company-object.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ functional_areas:

This section describes the REST endpoints used to manage `Company` objects.

**Service Name**
**Service Name:**

`companyCompanyRepositoryV1`

**REST Endpoints**
**REST Endpoints:**

```json
POST /V1/company/
Expand All @@ -30,7 +30,7 @@ DELETE /V1/company/:companyId
GET /V1/company/
```

**CompanyInterface Parameters**
**CompanyInterface Parameters:**

The following table lists the parameters defined in `CompanyInterface`.

Expand Down Expand Up @@ -61,11 +61,11 @@ Name | Description | Format | Requirements

The following example creates a company and assigns the default shared catalog (`customer_group_id`). The company admin (`super_user_id`) must be a previously-defined `customer_id`.

**Sample Usage**
**Sample Usage:**

`POST <host>/rest/<store_code>/V1/company/`

**Payload**
**Payload:**

```json
{
Expand All @@ -87,7 +87,7 @@ The following example creates a company and assigns the default shared catalog (
}
```

**Response**
**Response:**

```json
{
Expand Down Expand Up @@ -121,11 +121,11 @@ The following example creates a company and assigns the default shared catalog (

The following call changes the company status to Rejected (`2`) and explains why.

**Sample Usage**
**Sample Usage:**

`PUT <host>/rest/<store_code>/V1/company/2`

**Payload**
**Payload:**

```json
{
Expand All @@ -150,7 +150,7 @@ The following call changes the company status to Rejected (`2`) and explains why
}
```

**Response**
**Response:**

```json
{
Expand Down Expand Up @@ -183,15 +183,15 @@ The following call changes the company status to Rejected (`2`) and explains why
### Return all information about a company

This call returns detailed information about the specified company.
**Sample Usage**
**Sample Usage:**

`GET <host>/rest/<store_code>/V1/company/2`

**Payload**
**Payload:**

None

**Response**
**Response:**

```json
{
Expand Down Expand Up @@ -226,15 +226,15 @@ None

When you delete a company, Magento assigns the "Inactive" status to all company members. The system also removes company ID from the customer profile of all company members.

**Sample Usage**
**Sample Usage:**

`DELETE <host>/rest/<store_code>/V1/company/2`

**Payload**
**Payload:**

None

**Response**
**Response:**

`true`, indicating the request was successful

Expand All @@ -244,15 +244,15 @@ The following call returns all companies that are located in California (`region

See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query.

**Sample Usage**
**Sample Usage:**

`GET <host>/rest/<store_code>/V1/company?searchCriteria[filter_groups][0][filters][0][field]=region_id&searchCriteria[filter_groups][0][filters][0][value]=12&searchCriteria[filter_groups][0][filters][0][condition_type]=eq`

**Payload**
**Payload:**

None

**Response**
**Response:**

{% collapsible Show code sample %}
```json
Expand Down
52 changes: 26 additions & 26 deletions guides/v2.2/b2b/company-structures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ functional_areas:

Company teams allow you to group company users by location, job responsibilities, or any criteria you choose. You can assign individual company users to a team with the company hierarchy endpoints.

**Service name**
**Service name:**

`companyTeamRepositoryV1`

**REST Endpoints**
**REST Endpoints:**

```terminal
POST /V1/team/:companyId
Expand All @@ -27,7 +27,7 @@ DELETE /V1/team/:teamId
GET /V1/team/
```

**Company team parameters**
**Company team parameters:**

Name | Description | Format | Requirements
--- | --- | --- | ---
Expand All @@ -39,11 +39,11 @@ description | An optional description of the team. | string | Optional

A newly-created team is placed under Company Admin in the company hierarchy.

**Sample Usage**
**Sample Usage:**

`POST <host>/rest/<store_code>/V1/team/2`

**Payload**
**Payload:**

```json
{
Expand All @@ -54,19 +54,19 @@ A newly-created team is placed under Company Admin in the company hierarchy.
}
```

**Response**
**Response:**

The team ID, such as `4`.

### Update a team

You can only change the name or description of a team.

**Sample Usage**
**Sample Usage:**

`PUT <host>/rest/<store_code>/V1/team/4`

**Payload**
**Payload:**

```json
{
Expand All @@ -77,23 +77,23 @@ You can only change the name or description of a team.
}
```

**Response**
**Response:**

`true`, indicating the request was successful

### Return all information about a team

The `GET` call returns the team `id`, `name`, and `description`.

**Sample Usage**
**Sample Usage:**

`GET <host>/rest/<store_code>/V1/team/4`

**Payload**
**Payload:**

Not applicable

**Response**
**Response:**

```json
{
Expand All @@ -107,15 +107,15 @@ Not applicable

You cannot delete a team if members are assigned to it.

**Sample Usage**
**Sample Usage:**

`DELETE <host>/rest/<store_code>/V1/team/4`

**Payload**
**Payload:**

Not applicable

**Response**
**Response:**

An empty array

Expand All @@ -125,15 +125,15 @@ The following query returns information about all teams (`team_id` &ge; `0`)

See [Search using REST APIs]({{ page.baseurl }}/rest/performing-searches.html) for information about constructing a search query.

**Sample Usage**
**Sample Usage:**

`GET <host>/rest/<store_code>/V1/team?searchCriteria[filter_groups][0][filters][0][field]=team_id&searchCriteria[filter_groups][0][filters][0][value]=0&searchCriteria[filter_groups][0][filters][0][condition_type]=gteq`

**Payload**
**Payload:**

Not applicable

**Response**
**Response:**
{% collapsible Show code sample %}

```json
Expand Down Expand Up @@ -175,11 +175,11 @@ In the B2B storefront, a buyer can view the company structure represented as a h

You can use REST endpoints to retrieve the current structure and move teams and buyers within the hierarchy. You cannot delete teams or buyers.

**Service name**
**Service name:**

`companyHierarchyV1`

**REST Endpoints**
**REST Endpoints:**

```terminal
GET /V1/hierarchy/:id
Expand All @@ -201,15 +201,15 @@ Admin (structure_id = 2)
| |-- Teresa Gomez (customer, structure_id = 5)
```

**Sample Usage**
**Sample Usage:**

`GET <host>/rest/<store_code>/V1/hierarchy/2`

**Payload**
**Payload:**

Not applicable

**Response**
**Response:**

{% collapsible Show code sample %}

Expand Down Expand Up @@ -265,19 +265,19 @@ Not applicable

The following example moves Bryce Martin (`structure_id = 4`) to the West team (`structure_id = 7`)

**Sample Usage**
**Sample Usage:**

`PUT <host>/rest/<store_code>/V1/hierarchy/move/5`

**Payload**
**Payload:**

```json
{
"newParentId": 7
}
```

**Response**
**Response:**

`[]` (an empty array)

Expand Down
Loading