Skip to content

Add docs 3rd try #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
csantanapr wants to merge 3 commits into from
Closed

Add docs 3rd try #19

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3af1846
adding docs info
csantanapr May 19, 2021
b2ef952
remove grant
csantanapr May 19, 2021
ebe964b
add link for docs
csantanapr May 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 30 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,28 +41,34 @@ This roster is seeded with all approvers from Eventing workgroups.
- slinkydeveloper
- vaikas

## Docs roster

- csantanapr
- omerbensaadon
- julz

## Schedule

| Release | Release Date | Serving | Eventing | Unpin repos | PKG cut |
| ------- | ------------ | -------------- | --------------- | ----------- | ---------- |
| v0.17 | 2020-08-18 | yanweiguo | Harwayne | - | 2020-08-11 |
| v0.18 | 2020-09-29 | ZhiminXiang | n3wscott | 2020-08-19 | 2020-09-22 |
| v0.19 | 2020-11-10 | julz | n3wscott | 2020-09-30 | 2020-11-03 |
| v0.20 | 2021-01-12 | nak3 | slinkydeveloper | 2020-11-11 | 2021-01-07 |
| v0.21 | 2021-02-23 | mattmoor | lionelvillard | 2021-01-13 | 2021-02-16 |
| v0.22 | 2021-04-06 | markusthoemmes | evankanderson | 2021-02-24 | 2021-03-30 |
| v0.23 | 2021-05-18 | tcnghia | vaikas | 2021-04-07 | 2021-05-11 |
| v0.24 | 2021-06-29 | dprotaso | matzew | 2021-05-19 | 2021-06-22 |
| v0.25 | 2021-08-10 | JRBANCEL | ... | 2021-06-30 | 2021-08-03 |
| v0.26 | 2021-09-21 | ... | ... | 2021-08-11 | 2021-09-14 |
| Release | Release Date | Serving | Eventing | Docs | Unpin repos | PKG cut |
| ------- | ------------ | -------------- | --------------- | ----------- | ----------- | ---------- |
| v0.17 | 2020-08-18 | yanweiguo | Harwayne | richieescarez | - | 2020-08-11 |
| v0.18 | 2020-09-29 | ZhiminXiang | n3wscott | richieescarez | 2020-08-19 | 2020-09-22 |
| v0.19 | 2020-11-10 | julz | n3wscott | richieescarez | 2020-09-30 | 2020-11-03 |
| v0.20 | 2021-01-12 | nak3 | slinkydeveloper | richieescarez | 2020-11-11 | 2021-01-07 |
| v0.21 | 2021-02-23 | mattmoor | lionelvillard | csantanapr | 2021-01-13 | 2021-02-16 |
| v0.22 | 2021-04-06 | markusthoemmes | evankanderson | omerbensaadon | 2021-02-24 | 2021-03-30 |
| v0.23 | 2021-05-18 | tcnghia | vaikas | csantanapr | 2021-04-07 | 2021-05-11 |
| v0.24 | 2021-06-29 | dprotaso | matzew | julz | 2021-05-19 | 2021-06-22 |
| v0.25 | 2021-08-10 | JRBANCEL | ... | ... | 2021-06-30 | 2021-08-03 |
| v0.26 | 2021-09-21 | ... | ... | ... | 2021-08-11 | 2021-09-14 |

**NOTE:** v0.20 is moved by 3 weeks for end of year holidays

---

# 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

@vaikas vaikas May 20, 2021

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

@evankanderson evankanderson Jun 22, 2021

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?


For more information on the timetable, jump to the [Timetable](#timetable)
paragraph.
Expand Down Expand Up @@ -275,6 +281,15 @@ The artifact checksums can be found on the respective release pages. Once the
PR is merged, [cut a new branch](#cut-the-branch). There is no automation after
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

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

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

The current process can be summarize in the following:
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.

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

1. Wait for dependent repos to release (today thats /serving and /eventing)
Copy link
Copy Markdown
Contributor

@vaikas vaikas May 20, 2021

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

@vaikas vaikas May 20, 2021

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

@vaikas vaikas May 20, 2021

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 •
edited
Loading

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)

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.

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)

2. Generate the API specification and merge via PR into `main` branch https://github.com/knative/docs/pull/3426
3. Create the new relase branch on the `docs` repository https://knative.dev/help/maintainer/docs-release-process/#create-branch-from-updated-main
4. Update the `website` repository toml files to add the new version and drop the oldest version from the website https://github.com/knative/website/pull/287
5. Sync the staging branch in `website` repository to include all the same commits as `main` branch https://github.com/knative/website/pull/297

---

# Timetable
Expand All @@ -283,6 +298,8 @@ We release the components of Knative every 6 weeks. All of these components must
be moved to the latest "release" of all shared dependencies prior to each
release.

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

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.

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.

## First week of the rotation

### Make sure you have the right permission
Expand Down