From 1e78ccb6e742d0da9ad0c3ca88004012419df9ab Mon Sep 17 00:00:00 2001 From: Josh Bottum Date: Fri, 21 Oct 2022 18:33:34 -0500 Subject: [PATCH 1/5] proposed checklist for docs need for each release Adding a list of docs that should be reviewed before each release --- releases/handbook.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/releases/handbook.md b/releases/handbook.md index f7566392e..4e1336b66 100644 --- a/releases/handbook.md +++ b/releases/handbook.md @@ -266,11 +266,51 @@ those can start to be documented. - Create a [new version dropdown and update the website version](https://github.com/kubeflow/website/pull/3333) - Add new [release page with component and dependency versions](https://github.com/kubeflow/website/pull/3332) +**Release Documentation Checklist** + +The Kubeflow documentation is published in several locations: Kubeflow.org, GitHub and Distribution websites. In addition to the Success Criteria listed below, the following checklist provides a list of documentation that should be reviewed before a Kubeflow release. As a best practice, the Release Manager should ask the Release Docs Lead and the Working Groups Docs Leads to provide a status of the planned updates the checklist items, preferably four weeks before the release. + **Success Criteria:** Documentation for this release completed with minimum following pages updated and a [new version in the website is cut](https://github.com/kubeflow/kubeflow/blob/master/docs_dev/releasing.md#version-the-website). - [Installing Kubeflow](https://www.kubeflow.org/docs/started/installing-kubeflow/) - [Release Page](https://www.kubeflow.org/docs/releases/) - [Distributions](https://www.kubeflow.org/docs/distributions/) and related pages underneath +- [Manifest Top](https://github.com/kubeflow/manifests) +- [Manifest Releases](https://github.com/kubeflow/manifests/releases) +- [Manifest Components](https://github.com/kubeflow/manifests#kubeflow-components-versions) + +Change logs per Working Group + +- [Notebooks](https://github.com/kubeflow/kubeflow/releases) +- [Training Operator](https://github.com/kubeflow/training-operator/blob/master/CHANGELOG.md) +- [Katib](https://github.com/kubeflow/katib/blob/master/CHANGELOG.md) +- [Pipelines](https://github.com/kubeflow/pipelines/blob/master/CHANGELOG.md) +- [KServe](https://github.com/kserve/kserve/releases/) + +Working Group updates these pages (and the pages underneath) for the features changed in current release + +- [Notebooks](https://www.kubeflow.org/docs/components/notebooks/) +- [Training Operator](https://www.kubeflow.org/docs/components/training/) +- [Katib](https://www.kubeflow.org/docs/components/katib/) +- [Pipelines](https://www.kubeflow.org/docs/components/pipelines/) +- [KServe](https://kserve.github.io/website/0.9/) + +Release Team and Product Management updates + +- [Release Handbook +](https://github.com/kubeflow/community/blob/master/releases/handbook.md) +- [Kubeflow blog post](https://blog.kubeflow.org/) + +**Best practices for general documentation updates, documentation refactoring and distribution documentation.** + +*Non-release documentation updates* + +The Community has found that general or non-release documentation updates are often committed in the days prior to a release. These non-release updates are often needed, but they add additional reviews and approvals during a very busy time. As a best practice, documentation committers should try to have PRs ready for non-release updates prior to the Release feature freeze. + +*Long term re-factoring and distribution documentation* + +In the long term, the Community may want to re-factor the documentation, which might include separating the user functionality from the installation and administration documentation. Additionally, each individual distribution documentation should have moved, or have a plan to move, their documentation from Kubeflow.org. + ### Distribution testing (3 weeks) From d61cae85e3d596656b13e56530687c5627d5123d Mon Sep 17 00:00:00 2001 From: Josh Bottum Date: Mon, 24 Oct 2022 13:26:51 -0500 Subject: [PATCH 2/5] changed manifest top to manifest readme --- releases/handbook.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/releases/handbook.md b/releases/handbook.md index 4e1336b66..056f565f2 100644 --- a/releases/handbook.md +++ b/releases/handbook.md @@ -275,7 +275,7 @@ in the website is cut](https://github.com/kubeflow/kubeflow/blob/master/docs_dev - [Installing Kubeflow](https://www.kubeflow.org/docs/started/installing-kubeflow/) - [Release Page](https://www.kubeflow.org/docs/releases/) - [Distributions](https://www.kubeflow.org/docs/distributions/) and related pages underneath -- [Manifest Top](https://github.com/kubeflow/manifests) +- [Manifest Readme](https://github.com/kubeflow/manifests#readme) - [Manifest Releases](https://github.com/kubeflow/manifests/releases) - [Manifest Components](https://github.com/kubeflow/manifests#kubeflow-components-versions) From eda868042f30fa1c9807c263cecc184c7082e433 Mon Sep 17 00:00:00 2001 From: Josh Bottum Date: Thu, 27 Oct 2022 18:09:21 -0500 Subject: [PATCH 3/5] Update releases/handbook.md Co-authored-by: Anna --- releases/handbook.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/releases/handbook.md b/releases/handbook.md index 056f565f2..4fc9d2086 100644 --- a/releases/handbook.md +++ b/releases/handbook.md @@ -293,7 +293,7 @@ Working Group updates these pages (and the pages underneath) for the features ch - [Training Operator](https://www.kubeflow.org/docs/components/training/) - [Katib](https://www.kubeflow.org/docs/components/katib/) - [Pipelines](https://www.kubeflow.org/docs/components/pipelines/) -- [KServe](https://kserve.github.io/website/0.9/) +- [KServe](https://kserve.github.io/website/) Release Team and Product Management updates From c6741b14d17cff8fc937c787a1ef1b3be1bcf8ac Mon Sep 17 00:00:00 2001 From: Josh Bottum Date: Thu, 27 Oct 2022 18:09:44 -0500 Subject: [PATCH 4/5] Update releases/handbook.md Co-authored-by: Anna --- releases/handbook.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/releases/handbook.md b/releases/handbook.md index 4fc9d2086..2da1ad256 100644 --- a/releases/handbook.md +++ b/releases/handbook.md @@ -297,8 +297,7 @@ Working Group updates these pages (and the pages underneath) for the features ch Release Team and Product Management updates -- [Release Handbook -](https://github.com/kubeflow/community/blob/master/releases/handbook.md) +- [Release Handbook](https://github.com/kubeflow/community/blob/master/releases/handbook.md) - [Kubeflow blog post](https://blog.kubeflow.org/) **Best practices for general documentation updates, documentation refactoring and distribution documentation.** From 5c4411f39cbc8a5c1fb8f5a9eb6270eae1649bc9 Mon Sep 17 00:00:00 2001 From: Josh Bottum Date: Tue, 1 Nov 2022 20:24:07 -0500 Subject: [PATCH 5/5] refactor docs before feature freeze per Kimonas' suggestion. --- releases/handbook.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/releases/handbook.md b/releases/handbook.md index 2da1ad256..de1257b07 100644 --- a/releases/handbook.md +++ b/releases/handbook.md @@ -308,7 +308,7 @@ The Community has found that general or non-release documentation updates are of *Long term re-factoring and distribution documentation* -In the long term, the Community may want to re-factor the documentation, which might include separating the user functionality from the installation and administration documentation. Additionally, each individual distribution documentation should have moved, or have a plan to move, their documentation from Kubeflow.org. +In the long term, the Community may want to re-factor the documentation, which might include separating the user functionality from the installation and administration documentation. The larger documation refactoring PRs should be completed prior to the Release feature freeze. Additionally, each individual distribution documentation should have moved, or have a plan to move, their documentation from Kubeflow.org. ### Distribution testing (3 weeks)