Skip to content

Commit

Permalink
docs: migration guide updates for rdme docs upload (#1161)
Browse files Browse the repository at this point in the history
| 🚥 Resolves RM-11800 |
| :------------------- |

## 🧰 Changes

first (and hopefully totally adequate!) pass at the `rdme docs`
migration guide. we can continue to iterate after this initial beta is
out, based on feedback!

## 🧬 QA & Testing

does this language all look sound to you? any big points that we're
missing?
  • Loading branch information
kanadgupta authored Feb 3, 2025
1 parent cbc9004 commit 15e8c91
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions documentation/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ If you're using the `rdme` GitHub Action, update your GitHub Actions workflow fi
- Replace: `openapi` → `openapi upload` (see more in step 3 below)
- Replace: `categories` → use [Git-based workflow](https://docs.readme.com/main/docs/bi-directional-sync)
- Replace: `custompages` → use [Git-based workflow](https://docs.readme.com/main/docs/bi-directional-sync)
- Replace: `docs` (and its `guides` alias) → use [Git-based workflow](https://docs.readme.com/main/docs/bi-directional-sync)
- Replace: `docs` (and its `guides` alias) → `docs upload` (see more in step 4 below)
- Replace: `versions` → use [Git-based workflow](https://docs.readme.com/main/docs/bi-directional-sync)
- Remove: `open`

Expand All @@ -84,9 +84,21 @@ If you're using the `rdme` GitHub Action, update your GitHub Actions workflow fi

- There is no prompt to select your ReadMe project version if you omit the `--version` flag. It now defaults to `stable` (i.e., your main ReadMe project version).

- Previously with `openapi`, the `--id` flag was an ObjectID that required an initial upload to ReadMe, which made it difficult to upsert API definitions and manage many at scale. With `openapi upload`, the `--id` flag has been renamed to `--slug` and is now optional. The slug (i.e., the unique identifier for your API definition resource in ReadMe) is inferred from the file path or URL to your API definition.
- Previously with `openapi`, the `--id` flag was an ObjectId that required an initial upload to ReadMe, which made it difficult to upsert API definitions and manage many at scale. With `openapi upload`, the `--id` flag has been renamed to `--slug` and is now optional. The slug (i.e., the unique identifier for your API definition resource in ReadMe) is inferred from the file path or URL to your API definition.

Read more in [the `openapi upload` command docs](https://github.com/readmeio/rdme/tree/v10/documentation/commands/openapi.md#rdme-openapi-upload-spec).
Read more in [the `openapi upload` command docs](https://github.com/readmeio/rdme/tree/v10/documentation/commands/openapi.md#rdme-openapi-upload-spec) and in [the ReadMe API migration guide](https://docs.readme.com/main/reference/api-migration-guide).

4. **`docs` has been replaced by `docs upload`**

If you previously uploaded Markdown files to your Guides section via `rdme docs`, the command is now `rdme docs upload`. The command semantics are largely the same, but with a few small changes:

- The `--dryRun` flag has been deprecated in favor of `--dry-run`.

- Like `openapi upload` above, there is no prompt to select your ReadMe project version if you omit the `--version` flag. It now defaults to `stable` (i.e., your main ReadMe project version).

- `rdme docs upload` will now automatically validate your frontmatter and flag any issues prior to syncing. This is particularly helpful if you're coming from `rdme@9` or earlier, since the shape of certain frontmatter attributes (e.g., `category`, `parent`) have slightly changed. If you run this command in a non-CI environment, any outdated frontmatter will be detected and you'll have the ability to update it automatically.

Read more in [the `docs upload` command docs](https://github.com/readmeio/rdme/tree/v10/documentation/commands/docs.md#rdme-docs-upload-path) and in [the ReadMe API migration guide](https://docs.readme.com/main/reference/api-migration-guide).

## Migrating to `rdme@9`

Expand Down

0 comments on commit 15e8c91

Please sign in to comment.