Skip to content

Commit 6522bc0

Browse files
authored
docs(all): changes admonition types to 'info' (#1774)
1 parent c6b74be commit 6522bc0

File tree

9 files changed

+14
-14
lines changed

9 files changed

+14
-14
lines changed

docs/commands/push.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Apart from uploading your API description file, the `push` command can automatic
152152
- The `package.json` file (if it exists) from the folder where you're executing the `push` command. Redocly Workflows uses the `@redocly/cli` version specified in `package.json`.
153153
- The HTML template and the full contents of the folder specified as the `theme.openapi.htmlTemplate` parameter in the Redocly configuration file.
154154

155-
{% admonition type="attention" %}
155+
{% admonition type="info" %}
156156
If a plugin is referenced in the Redocly configuration file, the `push` command recursively scans the folder containing the plugin and uploads all `.js`, `.json`, `.mjs` and `.ts` files.
157157

158158
Make sure that each plugin has all the required files in its folder; otherwise, they are not uploaded.
@@ -260,7 +260,7 @@ Note that the organization ID can differ from the organization name. Owners can
260260

261261
#### API name and version
262262

263-
{% admonition type="attention" %}
263+
{% admonition type="info" %}
264264
The name and version of your API should contain only supported characters (`a-z`, `A-Z`, `0-9`, `-`, `.`). Using a restricted character results in an error, and your API doesn't get created.
265265
{% /admonition %}
266266

docs/configuration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,6 @@ theme:
242242
$ref: ./mockserver.yaml
243243
```
244244

245-
{% admonition type="attention" %}
245+
{% admonition type="info" %}
246246
When using the `push` command with a config file that includes `$ref`s, all referenced files are explicitly uploaded using the `--files` option.
247247
{% /admonition %}

docs/custom-plugins/visitor.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The `Schema` **visitor function** is called by Redocly CLI only if the Schema Ob
6767

6868
As the third argument, `enter()` in a **nested visitor object** accepts the `parents` object with corresponding parent nodes as defined in the **visitor object**.
6969

70-
{% admonition type="attention" %}
70+
{% admonition type="info" %}
7171
It is executed only for the first level of the Schema Object.
7272
{% /admonition %}
7373

docs/guides/configure-rules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ extends:
3636
3737
The configuration here is _very_ minimal with only the ruleset defined so far. Your config file also holds settings for themes, much more detailed configuration for linting and decorating, and custom plugins.
3838
39-
{% admonition type="attention" %}
39+
{% admonition type="info" %}
4040
You can also define rulesets and other linting details differently for each API if you need to.
4141
{% /admonition %}
4242

docs/guides/hide-apis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following image highlights what is to be removed in this tutorial.
2626

2727
## Prerequisites
2828

29-
{% admonition type="note" name="We do, You do" %}
29+
{% admonition type="info" name="We do, You do" %}
3030
This tutorial is most effective when you follow along and complete the steps.
3131
{% /admonition %}
3232

docs/guides/hide-specification-extensions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ For this tutorial, we've prepared a sample containing OpenAPI specification exte
1919

2020
## Prerequisites
2121

22-
{% admonition type="note" name="We do, You do" %}
22+
{% admonition type="info" name="We do, You do" %}
2323
This tutorial is most effective when you follow along and complete the steps.
2424
{% /admonition %}
2525

@@ -54,7 +54,7 @@ In this step, create a custom plugin and define the decorator dependency.
5454

5555
1. Save the file.
5656

57-
{% admonition type="attention" %}
57+
{% admonition type="info" %}
5858
You can name the plugins directory and the file anything you want. Make sure you use the correct name in the Redocly configuration file (Step 3 below).
5959
{% /admonition %}
6060

@@ -88,7 +88,7 @@ You can name the plugins directory and the file anything you want. Make sure you
8888

8989
1. Save the file.
9090

91-
{% admonition type="attention" %}
91+
{% admonition type="info" %}
9292
You can name the decorators directory anything you want. Make sure you use the correct directory name in the line 1 of the `plugin.js` file (Step 1 above).
9393
{% /admonition %}
9494

docs/guides/replace-servers-url.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ module.exports = function replaceServersUrlPlugin() {
9494

9595
3. Save the file.
9696

97-
{% admonition type="attention" %}
97+
{% admonition type="info" %}
9898
If you change the names of the plugins directory or the files, make sure to change them also in the Redocly configuration file [when registering your plugins and decorators](#add-a-decorator-and-associate-it-with-an-environment-variable).
9999
{% /admonition %}
100100

@@ -128,7 +128,7 @@ function ReplaceServersURL({serverUrl}) {
128128

129129
3. Save the file.
130130

131-
{% admonition type="attention" %}
131+
{% admonition type="info" %}
132132
If you change the name of the decorators directory, make sure to also change it in line 1 of the [`plugin.js` file](#create-a-custom-plugin).
133133
{% /admonition %}
134134

docs/guides/response-contains-property.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ Let's get started!
3535
└── users_{username}.yaml
3636
```
3737

38-
{% admonition type="note" %}
38+
{% admonition type="info" %}
3939
Make sure that the @redocly/cli has version `1.0.0-beta.99` or later
4040
{% /admonition %}
4141

4242
- If you're using VS Code as your favorite code editor, we recommend you install the [Redocly OpenAPI VS Code extension](https://redocly.com/docs/redocly-openapi/).
4343

44-
{% admonition type="note" name="We do, You do" %}
44+
{% admonition type="info" name="We do, You do" %}
4545
This guide is most effective when you follow along and complete the steps.
4646
{% /admonition %}
4747

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Before you start:
88
- Create a new project folder and `cd` into the folder
99
- If you have an OpenAPI description to use, copy it into your project (we assume it's called `openapi.yaml`), or [try our example](https://github.com/Redocly/openapi-starter/blob/main/openapi/openapi.yaml)
1010

11-
{% admonition type="attention" %}
11+
{% admonition type="info" %}
1212
There's also an [openapi-starter](https://github.com/Redocly/openapi-starter) repository that you can clone and experiment with to get your bearings
1313
{% /admonition %}
1414

0 commit comments

Comments
 (0)