proposed checklist for docs need for each release #581
Conversation
Adding a list of docs that should be reviewed before each release
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jbottum The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@DomFleischmann @annajung @kimwnasptd Per our discussion in the Release Team meeting, I have proposed adding this docs checklist to the release handbook. I would appreciate your review. |
releases/handbook.md
Outdated
| **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) |
There was a problem hiding this comment.
Lets point to the README.md in the url
There was a problem hiding this comment.
I agree, modified here: d61cae8
Co-authored-by: Anna <[email protected]>
Co-authored-by: Anna <[email protected]>
There was a problem hiding this comment.
Looks good @jbottum, thanks for this update! I have only one comment regarding big changes to the docs in the last minute.
releases/handbook.md
Outdated
|
|
||
| *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. |
There was a problem hiding this comment.
Should we also expose that as a best practice such long term re-factoring efforts, that might be huge as well, should not happen prior to the release?
Right now we are cutting the release branches of the website before a release. So we can't have such big efforts getting merged in the last minute.
per Kimonas' suggestion.
I have updated the doc with language to address your concern. |
|
@kimwnasptd would you please provide looks good? |
|
@DomFleischmann should we consider this list as we release 1.7 ? |
Adding a list of docs that should be reviewed before each release