Skip to content

Commit 640d5b1

Browse files
authored
Merge pull request #9892 from coreycb/release-docs
docs: move release docs to release directory
2 parents a5255ca + e6d0a16 commit 640d5b1

6 files changed

Lines changed: 14 additions & 17 deletions

File tree

docs/SUMMARY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ generator, in this case, **mdbook**. It defines the structure and navigation of
4545
- [Troubleshooting]()
4646
- [Collecting Debug Logs](user-guide/troubleshooting/collecting-debug-logs.md)
4747
- [Find your app version](user-guide/troubleshooting/find-your-app-version.md)
48-
- [Release](ci/README.md)
49-
- [Release Process](ci/RELEASE.md)
50-
- [Release Automation](ci/AUTOMATION.md)
48+
- [Release]()
49+
- [Release Process](release/RELEASE.md)
50+
- [Release Automation](release/AUTOMATION.md)
5151
- [Developer Release Checklist](release/developer-checklist.md)
52-
- [Manual Release (historical)](ci/HISTORICAL_RELEASE.md)
52+
- [Manual Release (historical)](release/HISTORICAL_RELEASE.md)
5353
- [Security]()
5454
- [Threat Modeling Guide](security/threat-modeling-guide.md)
5555

docs/ci/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/release/developer-checklist.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ This checklist is for developers. It summarizes what you (as a contributor/featu
44
- main → beta
55
- beta → release
66

7-
For the full release-driver process (branch locks, announcements, publishing), see [Release → Release Process](../ci/RELEASE.md).
7+
For the full release-driver process (branch locks, announcements, publishing), see [Release → Release Process](../release/RELEASE.md).
88

99
## Ongoing (between merges)
1010

1111
Do these as part of regular development:
1212

1313
- Identify potential uplifts early
14-
- Add risk and user impact notes to the issue/PR; ensure the fix lands on `main` and bakes on Daily first — see [Uplifts](../ci/RELEASE.md#uplifts) and [Uplift Criteria](../ci/RELEASE.md#uplift-criteria)
14+
- Add risk and user impact notes to the issue/PR; ensure the fix lands on `main` and bakes on Daily first — see [Uplifts](../release/RELEASE.md#uplifts) and [Uplift Criteria](../release/RELEASE.md#uplift-criteria)
1515
- Strings and translations
1616
- Avoid late string changes; if unavoidable, keep them small, so translators can catch up
1717
- Prefer not changing localizable strings for uplifts
@@ -29,7 +29,7 @@ Do these as part of regular development:
2929
## Before main → beta (developer responsibilities)
3030

3131
> [!NOTE]
32-
> A one-week [Soft Freeze](../ci/RELEASE.md#soft-freeze) occurs before merging `main` into `beta`.
32+
> A one-week [Soft Freeze](../release/RELEASE.md#soft-freeze) occurs before merging `main` into `beta`.
3333
3434
During soft freeze:
3535
- Avoid landing risky code changes
@@ -38,10 +38,10 @@ During soft freeze:
3838
Goal: Changes on `main` are safe to expose to a broader audience.
3939

4040
- Feature flags
41-
- Ensure flags match the [rules for beta](../ci/RELEASE.md#feature-flags)
41+
- Ensure flags match the [rules for beta](../release/RELEASE.md#feature-flags)
4242
- New features are disabled by default unless explicitly approved for beta
4343
- Not-ready features must be disabled
44-
- Prepare and merge a PR on `main` with necessary flag changes (before merge day)
44+
- Prepare and merge a PR on `main` with necessary flag changes (before soft freeze starts)
4545
- Translations
4646
- Ensure translation updates needed for your features are merged to `main`
4747
- If no Weblate PR is pending, trigger one and help review it (fix conflicts if needed)
@@ -51,10 +51,10 @@ Goal: Changes on `main` are safe to expose to a broader audience.
5151
Goal: Changes on `beta` are safe for general availability.
5252

5353
- Feature flags
54-
- Verify flags align with [rules for release](../ci/RELEASE.md#feature-flags)
54+
- Verify flags align with [rules for release](../release/RELEASE.md#feature-flags)
5555
- Features are disabled unless explicitly approved for release
5656
- Not-ready features remain disabled
57-
- If changes are required, open a PR on `main` and request uplift to `beta` following the criteria in [Uplift Criteria](../ci/RELEASE.md#uplift-criteria)
57+
- If changes are required, open a PR on `main` and request uplift to `beta` following the criteria in [Uplift Criteria](../release/RELEASE.md#uplift-criteria)
5858
- Translations
5959
- No new string changes at this stage; confirm your changes don’t introduce them
6060
- Stability checks you can influence
@@ -67,11 +67,11 @@ Goal: Changes on `beta` are safe for general availability.
6767
Paste the following snippet into your PR description to help reviewers and release drivers verify readiness for merge:
6868

6969
```markdown
70-
- [ ] Feature flags set according to target branch rules ([beta](../ci/RELEASE.md#feature-flags) / [release](../ci/RELEASE.md#feature-flags))
70+
- [ ] Feature flags set according to target branch rules ([beta](../release/RELEASE.md#feature-flags) / [release](../release/RELEASE.md#feature-flags))
7171
- [ ] Tests added/updated; CI green on affected modules
7272
- [ ] No new localizable strings (or justified and coordinated)
7373
- [ ] Translations accounted for (Weblate PR merged or not required)
74-
- [ ] Uplift label and risk/impact notes added if proposing uplift ([criteria](../ci/RELEASE.md#uplift-criteria))
74+
- [ ] Uplift template with risk/impact notes filled out if proposing uplift ([criteria](../release/RELEASE.md#uplift-criteria))
7575
```
7676

7777
## After merges (what developers should verify)
@@ -81,5 +81,5 @@ Paste the following snippet into your PR description to help reviewers and relea
8181
- Be prepared to propose/prepare a hotfix via the uplift process if necessary
8282

8383
> [!NOTE]
84-
> Merge-day coordination (branch locks, Matrix announcements, running scripts) is handled by release drivers. See [Merge Process](../ci/RELEASE.md#merge-process) for details.
84+
> Merge-day coordination (branch locks, Matrix announcements, running scripts) is handled by release drivers. See [Merge Process](../release/RELEASE.md#merge-process) for details.
8585

0 commit comments

Comments
 (0)