Publishing Workflow

This page is for documentation maintainers. It describes how to add a new Production Update.

Workflow

Create Draft
    ↓
Add release information
    ↓
Add change items
    ↓
Review by PM
    ↓
Deploy to Production
    ↓
Confirm production verification
    ↓
Publish Production Update

warning

Do not set status: Released until the production deployment is complete and verified.

Steps to publish a new release

1. Copy _template.mdx to docs/production-updates/YYYY/X.Y.Z.mdx
2. Fill in all required front matter fields and change items
3. Set slug: /production-updates/X-Y-Z for a permanent URL
4. Add an entry to src/data/productionUpdates.ts (newest first)
5. Add the doc path to sidebars.ts under the correct year
6. Run npm run build to verify no broken links
7. Open a pull request for PM review
8. Merge after production deployment is confirmed

Rollback

If a release is rolled back:

1. Change status to Rolled Back
2. Fill in rollbackInformation with date, reason, and affected items
3. Update updatedAt and updatedBy
4. Do not delete the release note

Content rules

Release notes must not contain API secrets, passwords, private keys, internal tokens, full database queries, sensitive player information, internal IP addresses, or production credentials.

Permissions

Role	Can do
Documentation Maintainer	Create, edit, publish, update, archive
Viewer	View, search, copy link, navigate

Without a role-based editing UI, publishing is done through the source repository and pull request.