kubeflow / website Goto Github PK

Lets add the Argo logo to the front page.

Will ask the Argo folks to attach their logo to this issue.

migrating this to website

Part of the confusion with new users is that outdated material is showing up first in searches. We need to pump up the SEO to make sure the current getting started/user guide is what they see first.

/assign @abhi-g
/assign @ewilderj

We should update the docs for 0.2.1 to reflect the new deploy scripts.

All the different starting guides should reference the new deploy.sh scripts

Related to kubeflow/kubeflow#240

We currently have getting started instructions for GKE & and minikube
https://github.com/kubeflow/website/blob/master/content/docs/getting-started-gke.md
https://github.com/kubeflow/website/blob/master/content/docs/getting-started-minikube.md

Do we want to add a getting started guide for Azure?

/cc @wbuchwalter @lachie83

• Move the instructions from Kubeflow repo.
• Update if needed to leverage Deployment Manager based installation.
• Incorporate bootstrapper based deployment instructions.
• Cover the case when deploying Kubeflow on an existing GKE cluster.

This is based on email by @ewilderj on kubeflow-discuss@

FYI here are the events we know about at Google where we'll be representing Kubeflow. Please feel free to chime in with others where you know you'll be speaking on KF.

Container Day (June 26)
OSCON TensorFlow Day  - July 17th
    Barbara Fusinska will be giving a Kubeflow talk
Google Next (July)
SciPy (July)
JupyterCon - Mid August 21-25  (Chris Cho, Fei Xue)
O’Reilly Strata NYC - September 11-13
    Workshop
    40-min talk
O’Reilly AI conference London - October 8-11
    TF Workshop 
Kafka Summit (October 16-17)
Kubecon Shanghai (November 14-15)
Kubecon Seattle (December 11-13)

I guess an events pager would make a great addition to the Kubeflow web site—good opportunity for somebody to submit their first PR to https://github.com/kubeflow/website if they want, then we can keep it up to date.

I'm finding the left-hand navigation panel a little confusing:

• The top-level section title is “Section Nav”. That title didn't help me understand what the section contains, which is a list of the docs available.
  How about this as a title for the top section: Docs

• The second section title is “Contents”. I thought it meant the contents of the doc set, but the section actually lists the headings on the page.
  How about this as a title for the top section: On this page
  An alternative suggestion: Page contents

The GKE getting started guide have several links to scripts/config files to be used
https://github.com/kubeflow/website/blob/master/content/docs/started/getting-started-gke.md

This links currently point at HEAD. But as part of a release we should update the links to point to the revision corresponding to the release.

In kubeflow/kubeflow#1109 @pdmack added a Docker image for Kaggle.

I think a short blog post on kubeflow.org explaining how to use it would be a great way to promote this and see how interested/useful people find this feature.

/cc @pdmack

Step-by-step walkthrough of a Tensorflow training and model serving example.

• Using public datasets available on GCS
• Using a local dataset.

This line (laptop <-> ML rig <-> training cluster <-> production cluster) in "The Kubeflow Mission" probably should be converted into a diagram with some pop to show the path through deployment envs.

/cc @ewilderj
/cc @abhi-g

Site looks great! But...

The Pytorch doc is currently in the "About" section of the docs
https://www.kubeflow.org/docs/about/pytorch/

It probably belongs rather in the "Getting Started" section:
https://www.kubeflow.org/docs/started/

Right now we have an uber user_guide with different sections for TFJob, Seldon, Jupyter, etc....

This won't scale.

I think we should create a new section either "Guides" that would be at the same level as the About and Getting Started section. We could then have individual pages for things like

• TFJob
• PyTorch
• Seldon
• JupyterHub

Kubernetes has a section called "Tasks" but @sarahmaddox (Technical Writer who will be contributing to Kubeflow) suggested Guides might be better. Lets go with her recommendation.

@sarahmaddox will be evaluate overall layout of the docs at some point. However, I think splitting up the user guide will significantly improve user's ability to find relevant information. So I'd prefer not to wait on that.

We should document how to switch the version of the TFJob CRD deployed in a cluster.

The basic commands would be something like the following

ks param set kubeflow-core tfJobVersion v1alpha2
kubectl -n kubeflow delete deploy tf-job-operator
kubectl delete crd tfjobs.kubeflow.org
ks apply ${ENV} -c kubeflow-core

We need to delete the existing CRD because we can't deploy two versions simultaneously.

We need a page that provides information about the community.

This would basically be the information currently in our README
https://github.com/kubeflow/kubeflow

Such as

• Google Group
• Slack Channel
• Twitter
• Community Calendar

Do we want/need a special getting started guide for open shift?

Related to kubeflow/kubeflow#240

/cc @willb @pdmack

A walkthrough of training Scikit or XGBoost models and deploy using Seldon.

How do we publish version of the website that map to versions of Kubeflow?

If you look at Kubernetes website I think they cut a version of the website for every version of K8s and then flip it over when the new version launches.

The mpi-job was added in 0.2. We should add docs to the website to call attention to it.

This can be simple and very similar to the existing README in the ksonnet registry.

#76
Is a good example.

We should have a blog post on kubeflow.org announcing the 0.2 release. This would be a great way to kickoff the blog.

We need to document how users transition from deploying Kubeflow to running the samples

I think we could directly point users at
https://github.com/kubeflow/examples/tree/master/github_issue_summarization

Provided we made a couple updates to the latter

• We should link to the official docs for setting up Kubeflow on kubeflow.org rather than repeating them in the example
• We should probably emphasize that users will need to have kubectl & ksonnet instead on their local machines

We should start a page in Guides->Components to discuss TFX integration in Kubeflow.

Some things to include in the page.

1. We should point out that TF Serving is part of TFX and link to the relevant page
2. TF.transform and TFMA are two other TFX components that are currently usable with Kubeflow (e.g. via Jupyter) we should point that out and provide links to the relevant TFX docs to get more info.

Docs were added in kubeflow/kubeflow#989; we should move them to our webiste.

• how to enable
• how to view logs, filtered by user labels
• how to view metrics in new UI

We have a getting-started guide for Kubernetes Engine, which uses the gke deploy script:
https://www.kubeflow.org/docs/started/getting-started-gke/

We need an end-to-end guide as well, to act as a "hello world" for people wanting to try out Kubeflow on Kubernetes Engine.

Identify any remaining blockers on the landing page design template. If all approvals are there, push it to the website repo.

Example of how to go about deploying and serving an existing TF model.

If users already have an existing Kubernetes cluster, this set of instructions will allow them to deploy Kubeflow on it.

• Include instructions using Bootstrapper.
• Include instructions without Bootstrapper.

Move over the instructions from the Kubeflow repo and organize the instructions inline as much of the setup as possible. Would be good to actually run through them to ensure they are still valid and up-to-date.

Create a list of topics from 0.1 release (such as features from the release) that we'd want to create blog posts for. Note that we'd be creating separate issues for writing out each of those blog posts, and the determining the release schedule.

Hi, I am trying to visit our website in China while I find I can not scroll down the Section Nav in the left side. When I opened the console I found that we use https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js while it cannot be visited in China. Thus the console has an error ReferenceError: jQuery is not defined[Learn More]

On user guide
https://www.kubeflow.org/docs/about/user_guide/

The contents nav section doesn't have a scroll bar and some of the items are cutoff. The scroll bar on the right side scrolls the page but not the nav bar.

A broken link check is described in
#62 (comment)

Can we run that as a presubmit test?

To enable tracking usage... and get data on traffic, generate ideas on what other content needs to be added.

Doesn't look like Tide plugin is enabled for this repository.

As part of setting up OAuth for IAP users need to setup authorized domains.

With a Cloud endpoints domain the authorized domains should include

<PROJECT>.cloud.goog

Need to identify the top level navigational items and update the page accordingly. Here is a potential suggestion for the list items:

• Getting Started
• Deployment
• Examples
• Community
• News/Blog
• FAQ/Getting Help
  Possibly use a document to define the sub-entries for each of those.

We need a list of P1 issues that need to be completed for our 0.2 release.

What state are we aiming our website to be in by 0.2?

/cc @ewilderj
/cc @willingc
/cc @texasmichelle

Maybe we could refer to https://github.com/kubernetes/website for details. I think they do not setup presubmit or postsubmit since it is a website repo.

Should we remove them from test-infra?

/cc @jlewi @ewilderj

We should add some docs on how to upgrade between different versions; even if that means telling people to delete everything and recreate it from scratch since we don't have an upgrade path right now.

Link to user guide at the end of the getting started guide to troubleshooting section is broken
https://www.kubeflow.org/docs/started/getting-started/

With a large amount of interest in Kubeflow coming from China, we should figure out how to support a Chinese translated site. Can this be automated translation?

Pull the content from the Community repo on how to get involved with Kubeflow community and start contributing.

Needs change in Section Nav template as well. This issue is a follow up of issue #97.

See this comment

On https://www.kubeflow.org/docs/started/getting-started-gke/
The text Create an OAuth Client ID links to
https://www.kubeflow.org/docs/started/getting-started-gke/getting-started-gke.md#create-oauth-client-credentials

But this doesn't exist

We'll need to create images that are sized for the front page sections: model serving and multi-framework to replace the placeholders that are there.

It looks like we can just publish it using GitHub pages
https://gohugo.io/hosting-and-deployment/hosting-on-github/

Once we do that we could probably setup some redirects for kubeflow.org and or docs.kubeflow.org

We should have a page that explains how to do batch prediction.