Skip to content

Commit b2fdf87

Browse files
authored
docs: update the v2 migration guide (#2231)
1 parent 48665ab commit b2fdf87

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ Supports OpenAPI 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6
1111

1212
![OpenAPI CLI toolset](./media/redocly-cli.gif)
1313

14+
## Migration
15+
16+
Migrating from Redocly CLI v1 to v2?
17+
Here's the [guide](https://redocly.com/docs/cli/guides/migrate-to-v2) to make the transition smoother.
18+
1419
## Usage
1520

1621
### Node

docs/@v2/guides/migrate-to-v2.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ This affects [plugins](../configuration/reference/plugins.md): update your plugi
1616

1717
### Configuration changes
1818

19+
The only default configuration file name is now `redocly.yaml`.
20+
If you still use the legacy `.redocly.yaml`, please rename it.
21+
You can still use a different file name, but you must explicitly specify it with the `--config` flag.
22+
1923
Several deprecated configuration options have been removed:
2024

2125
```yaml
@@ -120,11 +124,6 @@ rules:
120124
- **Commands**: The `preview-docs` command has been removed - use `preview` instead.
121125
- **Labels**: The `labels` field in the `apis` section has been removed.
122126

123-
### Config file name
124-
125-
The only default configuration file name is now `redocly.yaml`.
126-
You can still use a different file name, but you must explicitly specify it with the `--config` flag.
127-
128127
## New features
129128

130129
### Spec ruleset

0 commit comments

Comments
 (0)