Add docs 3rd try#19
Conversation
csantanapr
commented
May 19, 2021
- add rotation for docs
- add a summary for docs release
Signed-off-by: Carlos Santana <csantana23@gmail.com>
Signed-off-by: Carlos Santana <csantana23@gmail.com>
Signed-off-by: Carlos Santana <csantana23@gmail.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
/assign @vaikas |
|
Thanks! Which instructs the current release leads to create a PR like this: knative/community#619 |
|
@julz since you're the release lead for docs for .24 |
|
Expectation for the release 0.24 is that a person from docs only release docs. In this case @julz For release 0.25 then the release lead releasing eventing and serving to also release docs. There should not be any special (ie netlify) permissions to release docs by then. Only the same permissions given to other repos for example create tags, branches, and self approve PRs on the docs repo for the time period of being release lead. And this I believe is automated today we just need to add docs repo as part of the automation granting and removing permission. |
| # Instructions | ||
|
|
||
| Below you'll find the instructions to release a `knative.dev` repository. | ||
| Below you'll find the instructions to release the docs repository see [Release docs](#release-docs) |
There was a problem hiding this comment.
I don't think we want this change? These are the instructions for all the other repos, so I'd think we want to leave them as is.
There was a problem hiding this comment.
this comment seems unresponded to?
| ## Release docs | ||
| To release the documentation for the release follow [docs release process](https://knative.dev/help/maintainer/docs-release-process/) | ||
| The current process can be summarize in the following: | ||
| 1. Wait for dependent repos to release (today thats /serving and /eventing) |
There was a problem hiding this comment.
https://knative.dev/help/maintainer/docs-release-process/
seemed to indicate there's three repos (client?) But I think on slack you said there's four (operator), so I made this fix(?) there:
https://github.com/knative/docs/pull/3631/files
There was a problem hiding this comment.
I think we should remove the now old section that says to skip the docs repo:
https://github.com/knative/release/pull/19/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R465
And add this whole section there.
There was a problem hiding this comment.
Reasoning why I think it doesn't belong here is because that link has all the (and then some) details (how to cut a branch, etc.) and I personally found it confusing intermingled here because it's entirely different procedure currently. Client stuff that was added recently are steps that are necessary beyond the normal steps so they made sense to be in this section. WDYT?
There was a problem hiding this comment.
What's about splitting the document into two major sections:
- Releasing the code
- Releasing the documentation
And add a top-level ToC highlighting this difference. We then can also just say "release the docs after the code" which also automatically includes all dependencies. I think that makes sense because you are then free in the docs to reference any additional repos (beyond serving and eventing) and you don't have to take care to update this release document. I see the parallelization benefit (starting the docs release before all repositories has been published) as not big enough to introduce this additional maintenance dependency (updating this doc everytime you want to depend on a new repo in the docs)
|
|
||
| ## Release docs | ||
| To release the documentation for the release follow [docs release process](https://knative.dev/help/maintainer/docs-release-process/) | ||
| The current process can be summarize in the following: |
There was a problem hiding this comment.
| The current process can be summarize in the following: | |
| The current process can be summarized in the following: |
| this, so you're done here. | ||
|
|
||
| ## Release docs | ||
| To release the documentation for the release follow [docs release process](https://knative.dev/help/maintainer/docs-release-process/) |
There was a problem hiding this comment.
| To release the documentation for the release follow [docs release process](https://knative.dev/help/maintainer/docs-release-process/) | |
| To release the documentation follow [docs release process](https://knative.dev/help/maintainer/docs-release-process/) |
| ## Release docs | ||
| To release the documentation for the release follow [docs release process](https://knative.dev/help/maintainer/docs-release-process/) | ||
| The current process can be summarize in the following: | ||
| 1. Wait for dependent repos to release (today thats /serving and /eventing) |
There was a problem hiding this comment.
| 1. Wait for dependent repos to release (today thats /serving and /eventing) | |
| 1. Wait for dependent repos to be released (today that's /serving and /eventing) |
| release. | ||
|
|
||
| The docs are released after serving and eventing are released, see [Release docs](#release-docs) | ||
|
|
There was a problem hiding this comment.
See my comment above, I would suggest making this more prominent and just say: The docs should be released after the code has been released (so that the docs release team does not need to be aware of the details on which repo it depends. E.g. when including examples from r links to the released client tag or client plugins tag, then you would otherwise need to update this instruction here, which can be easily forgotten, too).
Also, as soon as you add a link to released client plugins, you would have to wait anyway until everything is released, as those plugins are the last to be released.
|
@csantanapr release is next week do you want to wrap up this PR so that docs is part of the process cc @julz who seems to be the docs release shepherd |
|
@csantanapr: PR needs rebase. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@csantanapr: PR needs rebase. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
bump - it's been a month and the new release is almost two weeks out |
|
@csantanapr Since today is release day, any chance this could get updated to make sure the process is up-to-date? Or, has it been addressed already in some other PR and I missed it? |
|
Closing this out since there hasn't been any movement |