Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: v9 doc touch-ups #1121

Merged
merged 4 commits into from
Dec 13, 2024
Merged

docs: v9 doc touch-ups #1121

merged 4 commits into from
Dec 13, 2024

Conversation

kanadgupta
Copy link
Member

@kanadgupta kanadgupta commented Dec 11, 2024

🧰 Changes

doc updates that we should push to the v9 channel right before we release v10! see #1113 for the sequencing of all of this.

@kanadgupta kanadgupta added the documentation Improvements or additions to documentation label Dec 11, 2024
@kanadgupta kanadgupta mentioned this pull request Dec 11, 2024
11 tasks
@kanadgupta kanadgupta marked this pull request as ready for review December 11, 2024 23:56
@kanadgupta kanadgupta requested review from erunion and mjcuva December 11, 2024 23:56
@kanadgupta kanadgupta changed the base branch from next to v9 December 12, 2024 23:49
kanadgupta added a commit that referenced this pull request Dec 12, 2024
## 🧰 Changes

this PR aggregates all of the PRs going out as part of the v10 release
(i.e, the second section of PRs below). all PRs should be reviewed prior
to being merged into this branch.

### outstanding tasks

#### needs to go out _before_ v10 is released (i.e., in the v9 release
channel)
- [x] #1082


#### needs to go out as part of v10 release
- [x] `openapi upload`
  - [x] #1111
  - [x] #1116
- [x] #1107
- [x] #1104
- [x] #1108

#### merge into `v9` branch once `v10` release is successfully released
- [ ] #1121

#### double-check these things before merging

- [x] swap out any links to the `v9` docs (e.g., `/tree/v9`) with `v10`
as needed
(b19416d)
- [x] make sure all API v1 requests in `v10` will work
- [x] make sure v10 migration guide reflects the final design decisions
around `openapi upload`

## ⚠️ Breaking Changes

<sub>listing all of the breaking changes 1 by 1 below so they get picked
up by semantic release...</sub>

BREAKING CHANGE: `categories`, `custompages`, `docs` and `versions` have
now been removed. Please use a bidirectional syncing workflow instead.
Read more in [our migration
guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md).

BREAKING CHANGE: `rdme openapi` has been replaced by `rdme openapi
upload`. Read more in [our migration
guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md).
@kanadgupta kanadgupta merged commit 8b09e87 into v9 Dec 13, 2024
10 checks passed
@kanadgupta kanadgupta deleted the kanad-2024-12-11/v9-doc-updates branch December 13, 2024 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants