From f1b758ca065c61030690b9064c762c0a801ea878 Mon Sep 17 00:00:00 2001 From: Noah Talerman <47070608+noahtalerman@users.noreply.github.com> Date: Fri, 20 Sep 2024 17:15:27 -0400 Subject: [PATCH] New Product design responsibility Prepare reference docs for release --- handbook/product-design/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/handbook/product-design/README.md b/handbook/product-design/README.md index 3a269485f8b6..9a2b02939b83 100644 --- a/handbook/product-design/README.md +++ b/handbook/product-design/README.md @@ -191,6 +191,15 @@ available in Google Drive. Some of the data is forwarded to [Datadog](https://us5.datadoghq.com/dashboard/7pb-63g-xty/usage-statistics?from_ts=1682952132131&to_ts=1685630532131&live=true) and is available to Fleeties. +### Prepare reference docs for release + +Every change to how Fleet is used is reflected live on the website in reference documentation **at release day** (REST API, config surface, tables, and other already-existing docs under /docs/using-fleet). + +To make sure this happens, first, the [DRI for what goes in a release](https://fleetdm.com/handbook/company/communications#directly-responsible-individuals-dris) @ mentions the [API design DRI](https://fleetdm.com/handbook/company/communications#directly-responsible-individuals-dris) in a message in #help-engineering Slack channel when we cut the release candidate (RC). + +Next, the API design DRI reviews all user stories with the release milestone to check that all reference doc PRs are merged into the reference docs release branch. To see which stories were pushed to the next release, and thus which reference doc changes need to be removed from the branch, the API design DRI filters issues by the `~pushed` label and the next release's milestone. + +To signal that the reference docs branch is ready for release, the API design DRI opens a PR to `main`, adds the DRI for what goes in a release as the reviewer, and adds the release milestone. ## Rituals