Kubeflow 1.2 release doc changes

[Jeffwan]

I create this issue to track coming 1.2 doc changes. WG owners and platform owners, it would be great to link your WIG or PRs there to help on tracking.

We will cut a 1.2 branch from masters around Nov 8.

Docs for versioning the website: https://github.com/kubeflow/kubeflow/blob/master/docs_dev/releasing.md#version-the-website

[issue-label-bot]

Issue-Label Bot is automatically applying the labels:

Label	Probability
kind/feature	0.79
area/docs	1.00

Please mark this comment with 👍 or 👎 to give our bot feedback!
Links: app homepage, dashboard and code for this bot.

[Jeffwan]

@8bitmp3 @RFMVasconcelos Do you have capacity to drive 1.2 website release?

[andreyvelich]

@Jeffwan From AutoML WG these PRs are related to 1.2:

• Katib v1beta1 documentation update #2312
• Disable ephemeral storage in Katib Config #2315
• Add Katib metric strategies info #2316
• Update Istio sidecar annotation information for the Katib experiments #2320
• Default values for Katib Trials count #2321
• Add resume policy instructions for Katib experiments #2324
• New trial template design for Katib #2332
• Add Katib early stopping documentation #2336

That is the main issue to track the release: kubeflow/katib#1360.

/cc @johnugeorge @gaocegege

[rui-vas]

Thank you for creating this issue @Jeffwan!

I can help drive this effort. Do you say you'll cut a 1.1 branch on Nov 8th?

[andreyvelich]

@Jeffwan Why we will cut 1.1 branch ?
I assumed 1.1 branch had to be cut when we released Kubeflow 1.1 ?
And on 8th of November we should cut 1.2 branch.

Am I misunderstanding something ?

[Jeffwan]

@RFMVasconcelos @andreyvelich Typo..I correct the branch name, it should be v1.2-branch.

@RFMVasconcelos Thanks. If you can help drive this and cut v1.2-branch on website. That would be great. I

[rui-vas]

Hi @Jeffwan @andreyvelich !

So the way we do it is that we change master to be the latest version, now -> v1.2, and we create a new branch for the previous version - v1.1.

If you look, today we don't have a v1.1-branch on the website repo as v1.1 is now in master

[rui-vas]

Happy to drive the cut of v1.1-branch this week.

[rui-vas]

@jlewi, it seems that I do not have the permissions to create a new branch upstream. Would it be possible to give me these permissions, or can someone else do this?

[jlewi]

@RFMVasconcelos
https://github.com/kubeflow/community/blob/master/how-to/github_admin.md
https://github.com/kubeflow/internal-acls/blob/4535a60993946dcb57a05cd33552518030410ac5/github-orgs/kubeflow/org.yaml#L1100
https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization

[rui-vas]

Thank you!

[rui-vas]

@jlewi I created the PR to update permissions. ☝️

[Jeffwan]

@RFMVasconcelos I get some feedbacks from WG owners. Most WGs owners just finish code and manifest updates this week. They are working on docs changes. Can we postpone the website branch cut a little bit late? I propose to do it on Nov 11 instead of the end of this week. What do you think?

one example is #2322 (comment) /cc @andreyvelich

[rui-vas]

@Jeffwan that's ok! I can do it early next week ;)

These updates are things we will want to stay in Kubeflow v1.1 docs?

[Jeffwan]

em. See kubeflow/kubeflow#5371 (comment)
doc repo is managed in a different way. it lags 1 version. The time we cut v1.1-branch, that means v1.1 is not the latest version and all changes on master will also go online (kubeflow.org points to master).

So I think we don't want those changes coming into v1.1 since they are v1.2 only. Can we accept new changes on master and then cut branch from a stable commit without v1.2 related changes? Any better ideas?

[andreyvelich]

I think if we want to cut the v1.1 website release, we need to choose one of the past commits and make the release. For example: 97dc746.
I believe the multi-user doc for the Kubeflow Pipelines was ready at this time.

If we can't find the commit for the v1.1 website, we should skip this version and directly cut v1.2 for the Kubeflow 1.2 release, once all required PRs docs will be merged to the master.

As I can see, currently the Kubeflow website points the master version to the 1.1 branch:

I think it is not correct, because:

1. v1.1-branch doesn't exists (https://github.com/kubeflow/website/branches/all?page=1).
2. Master version of the website should always point to the master branch.

What do you think @Jeffwan @RFMVasconcelos ?

/cc @Bobgy @jlewi @8bitmp3

[Jeffwan]

@andreyvelich It's by design. see kubeflow/kubeflow#5371 (comment)

it's a little bit different from other projects. I think both solution work. website normally is changed frequently when user notice there's issue for latest branch. If we follow kubeflow/kubeflow way, then

1. There will be lots of cherry-picks or user directly submit PR against v1.1-branch
2. Kubeflow.org needs to switch to last stable version like v1.1 instead of master.

The v1.1 in banner doesn't mean there's a tag or version named v1.1. It's same as master. I know this is confuse, I think if most people want to do it in a different way, that works as well.

[jlewi]

@Jeffwan is correct

• We wait to cut the v1.1 docs branch because docs lag behind

• We cut the v1.1 branch only when we are ready to start updating the docs for 1.2

  • We are probably at a point where people want to start committing 1.2 changes so cutting the 1.1 branch is a good idea
  • As @andreyvelich mentions we can cut the branch on a past commit if there have already been changes that are only relevant to 1.2

• We can independently control whether www.kubeflow.org points to master or a 1.X branch

• So after cutting 1.1 docs branch we should update www.kubeflow.org to point at 1.1

• We can then develop 1.2 docs on master which will be available at master.kubeflow.org

• When we are ready to release 1.2 we should flip www.kubeflow.org to point to the master branch containing 1.2 docs.

[rui-vas]

Sounds good @jlewi, @Jeffwan !

I am happy to make the v1.1-branch cut + redirect when we're ready.

@andreyvelich are there any merged docs that are v1.2 specific hence forcing a cut from a past commit? If not I'd rather do the cut at the current state.

The commit you mention is 1 month old, which means some relevant commits might be lost, including some of our recent efforts to remove "outdated" banners.

WDYT?

[andreyvelich]

@RFMVasconcelos From AutoML WG only this commit is related to 1.2: 1df2cb9.

[Jeffwan]

@RFMVasconcelos

I think this should be a safe commit?

I am not sure about #2327 that manifest change is not in 1.1-branch but master. @shawnzhu update KFDef to master which is fine for v1.1 users

It doesn't seem there're lots of updates from WG recently.

[rui-vas]

Ok @Jeffwan!

From the meeting, it seemed like nobody had big objections. I will use that commit and then ask the leads to review if there is any inconsistency on the v1.1-branch

[rui-vas]

Branch created -> https://github.com/kubeflow/website/tree/v1.1-branch

[rui-vas]

Netlify deployed v1.1 version:
https://v1-1-branch--competent-brattain-de2d6d.netlify.app/

[rui-vas]

Hey @jlewi @Bobgy, I've done steps 1 & 2 of the "Creating and publishing a website branch for vX.Y" guide. ☝️

I'm stuck on step 3, as I don't have access to the Cloud DNS of Kubeflow.org.

How should I proceed?

[jlewi]

One of @kubeflow/google-admins will have to do the DNS steps.

[rui-vas]

Thank you for clarifying @jlewi. Could any of the @kubeflow/google-admins provide a timeline for this?

Many thanks!

[Bobgy]

I'll take a look tomorrow

[Bobgy]

I've updated DNS record, https://v1-1-branch.kubeflow.org/ shows up correctly. It hasn't updated SSL certificate yet, I'm contacting netlify to set it up.

[Bobgy]

After SSL ready, I'll do "Changing the version www.kubeflow.org points to" step

[rui-vas]

Awesome! Let me know if you want me to do any of the next steps

[Bobgy]

OK, SSL is now ready. I've also switched netlify to build v1.1-branch as kubeflow.org content.
@RFMVasconcelos can you continue to update master branch's label so it shows as v1.2

[rui-vas]

Hi @Bobgy!

Thank you for the help! I can take care of that until EOW

[Jeffwan]

@RFMVasconcelos We cut code release. do you want to update the docs?

[rui-vas]

Hey @Jeffwan!

I have updated the website versioning -> #2365

Also opened issues for the following steps that are in the versioning guide:

• Kubeflow v1.2 docs - updating shortcodes for config files and KFDefs #2366 for updating shortcodes for config files and KFDefs
• Update Kubernetes vs Kubeflow versions matrix #2367 for K8s version matrix

[thesuperzapper]

@RFMVasconcelos are you going to cut a 1.2 branch, rather than just pointing to master?

[Bobgy]

Shall we resolve the urgent issue first? We need to decide on a date when master will be shown as default for www.kubeflow.org instead of v1.1-branch.kubeflow.org.

Doc updates on GCP side is almost done, I have one last PR waiting to be merged.

[Bobgy]

/cc @Jeffwan
maybe you should make the call for "when we show 1.2 docs by default".

[rui-vas]

@thesuperzapper we're going to point to master.

It seems that we're only missing this step to update to v1.2.

I think we're ready to do this @Bobgy. I do not have access to Netlify, perhaps this needs to be done by a Googler?

[Bobgy]

GCP side is ready.

/cc @kubeflow/aws @kubeflow/arrikto @kubeflow/azure @Jeffwan @animeshsingh

Did I miss any stakeholders?

If no one raises an objection, I will switch doc to master next Tuesday.

[8bitmp3]

@Bobgy Double check with Seldon @cliveseldon and KFServing @andreyvelich

@animeshsingh Does IBM have a @kubeflow/ibm team handle? @Tomcli

[8bitmp3]

cc @kubeflow/wg-automl-leads @kubeflow/wg-notebook-leads @kubeflow/wg-pipeline-leads @kubeflow/wg-training-leads @kubeflow/wg-serving-leads just to keep everyone in the loop

[andreyvelich]

From AutoML WG all required docs were updated on November 14th.
That is the latest commit: b2ad541.

[Bobgy]

Updated default branch to master, once the next commit lands in master, the website will switch over to master as default.

[PatrickXYS]

Update from AWS Side, we have updated our doc to v1.2

[rui-vas]

It seems that v1.2 docs are live!! 🚀

Thank you for the help @Bobgy!

/close

[k8s-ci-robot]

@RFMVasconcelos: Closing this issue.

In response to this:

It seems that v1.2 docs are live!! 🚀

Thank you for the help @Bobgy!

/close

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.