Skip to content

Add docs 3rd try#19

Closed
csantanapr wants to merge 3 commits into
knative:mainfrom
csantanapr:add-docs-3rd-try
Closed

Add docs 3rd try#19
csantanapr wants to merge 3 commits into
knative:mainfrom
csantanapr:add-docs-3rd-try

Conversation

@csantanapr
Copy link
Copy Markdown
Member

  • 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>
@csantanapr csantanapr requested review from a team as code owners May 19, 2021 17:24
@csantanapr csantanapr requested a review from a team May 19, 2021 17:24
@knative-prow-robot
Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign markusthoemmes after the PR has been reviewed.
You can assign the PR to them by writing /assign @markusthoemmes in a comment when ready.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-cla google-cla Bot added the cla: yes Indicates the PR's author has signed the CLA. label May 19, 2021
@knative-prow-robot knative-prow-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 19, 2021
@csantanapr
Copy link
Copy Markdown
Member Author

This replaces #10 and #15

@csantanapr
Copy link
Copy Markdown
Member Author

/assign @vaikas

@csantanapr
Copy link
Copy Markdown
Member Author

cc @omerbensaadon

@vaikas
Copy link
Copy Markdown
Contributor

vaikas commented May 20, 2021

Thanks!
Does the docs rotation need to also be added to release leads, or is the expectation that they only release the docs repo? Reason I ask is that serving/eventing release leads release all the other repos (not limited to eventing RL only doing eventing related repos) and hence they need some ninja powers. Depending on that answer, we might need to adjust some additional steps like this one:
https://github.com/knative/release/blob/main/README.md#after-the-release

Which instructs the current release leads to create a PR like this: knative/community#619

@vaikas
Copy link
Copy Markdown
Contributor

vaikas commented May 20, 2021

@julz since you're the release lead for docs for .24

@csantanapr
Copy link
Copy Markdown
Member Author

csantanapr commented May 20, 2021

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.

Comment thread README.md
# 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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this comment seems unresponded to?

Comment thread README.md
## 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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Contributor

@rhuss rhuss Jun 7, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Comment thread README.md

## 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:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The current process can be summarize in the following:
The current process can be summarized in the following:

Comment thread README.md
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/)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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/)

Comment thread README.md
## 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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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)

Comment thread README.md
release.

The docs are released after serving and eventing are released, see [Release docs](#release-docs)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@dprotaso
Copy link
Copy Markdown
Member

@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

@knative-prow-robot knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 30, 2021
@knative-prow-robot
Copy link
Copy Markdown

@csantanapr: PR needs rebase.

Details

Instructions 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.

@knative-prow-robot
Copy link
Copy Markdown

@csantanapr: PR needs rebase.

Details

Instructions 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.

@dprotaso
Copy link
Copy Markdown
Member

bump - it's been a month and the new release is almost two weeks out

@vaikas
Copy link
Copy Markdown
Contributor

vaikas commented Aug 10, 2021

@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?

@vaikas vaikas removed their assignment Aug 12, 2021
@dprotaso
Copy link
Copy Markdown
Member

Closing this out since there hasn't been any movement

@dprotaso dprotaso closed this Sep 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes Indicates the PR's author has signed the CLA. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants