diff --git a/proposals/restructure-KF-docs-proposal.md b/proposals/restructure-KF-docs-proposal.md new file mode 100644 index 000000000..73372c2a4 --- /dev/null +++ b/proposals/restructure-KF-docs-proposal.md @@ -0,0 +1,233 @@ +This is an initial proposal, to be iterated on, following the discussion in [#2293](https://github.com/kubeflow/website/issues/2293). + +### Kubeflow documentation structure + +- **Home** (tab to be added) + +- **Getting started** + - Introduction (current About/Kubeflow) + - Getting started (current `Getting started/Installing Kubeflow` updated to guide users to platforms & methods) + - Concepts (current Kubeflow Overview) + - Use Cases (current About/Use Cases) + - Install Kubeflow (current `Installing Kubeflow`, to redirect to `Deployment` homepage) + - [delete] Cloud Installation + +- **Community** + - About (current About/Community) + - Contributing (current About/Contributing to Kubeflow + details on Working Groups) + - Documentation (merge current About/Docs + About/Style Guide for Kubeflow docs) + - Events (current About/Events Calendar) + - Google Summer of Code (current About/Google Summer of Code) + +- **Components** (remove "of Kubeflow", components reordered as per user journey) + - Central Dashboard + - Central Dashboard + - Registration Flow + - Notebook Servers (moved to under components, renamed from "Jupyter Notebooks") + - Overview of Jupyter Notebooks in Kubeflow + - Set Up Your Notebooks + - Create a Custom Jupyter Image + - Submit Kubernetes Resources + - Build a Docker Image on GCP + - Troubleshooting Guide + - Kubeflow Pipelines (add "Kubeflow", remove redirects) + - Pipelines Quickstart + - Installing Pipelines + - Installation Options for Kubeflow Pipelines + - Kubeflow Pipelines Standalone Deployment + - Deploying Kubeflow Pipelines on a local cluster + - Understanding Pipelines + - Overview of Kubeflow Pipelines + - Introduction to the Pipelines Interfaces + - Concepts + - Building Pipelines with the SDK + - Introduction to the Pipelines SDK + - Install the Kubeflow Pipelines SDK + - Build Components and Pipelines + - Create Reusable Components + - Building Python function-based components + - Best Practices for Designing Components + - Pipeline Parameters + - Python Based Visualizations + - Visualize Results in the Pipelines UI + - Pipeline Metrics + - DSL Static Type Checking + - DSL Recursion + - Using environment variables in pipelines + - GCP-specific Uses of the SDK + - Manipulate Kubernetes Resources as Part of a Pipeline + - Multi-user Isolation for Pipelines + - Caching + - Upgrading + - Samples and Tutorials + - Using the Kubeflow Pipelines Benchmark Scripts + - Using the Kubeflow Pipelines SDK + - Experiment with the Kubeflow Pipelines API + - Experiment with the Pipelines Samples + - Run a Cloud-specific Pipelines Tutorial + - Troubleshooting + - Reference + - Component Specification + - Pipelines API Reference + - Pipelines SDK Reference + - Frameworks for Training + - Chainer Training + - MPI Training + - MXNet Training + - PyTorch Training + - TensorFlow Training (TFJob) + - Tools for Serving + - Overview + - KFServing + - Seldon Core Serving + - BentoML + - NVIDIA Triton Inference Server + - TensorFlow Serving + - TensorFlow Batch Prediction + - Katib + - Introduction to Katib + - Getting Started with Katib + - Running an Experiment + - Resuming an Experiment + - Overview of Trial Templates + - Using Early Stopping + - Katib Configuration Overview + - Environment Variables for Katib Components + - Metadata + - Fairing + - Overview of Kubeflow Fairing + - Install Kubeflow Fairing + - Configure Kubeflow Fairing + - Fairing on Azure + - Fairing on GCP + - Tutorials + - Reference + - Feature Store + - Introduction to Feast + - Getting started with Feast + - Nuclio functions (remove "Miscellaneous" layer) + - Istio (remove "usage in Kubeflow") + - Multi-Tenancy (remove "in Kubeflow") + - Introduction to Multi-user Isolation + - Design for Multi-user Isolation + - Getting Started with Multi-user Isolation + - Gang-scheduling (current "Job scheduling" - only keep if has owners) + +- **Platforms** + - Workstation (remove "Installation") + - Linux (remove "Kubeflow on") + - macOS (remove "Kubeflow on") + - Windows (remove "Kubeflow on") + - On-prem + - On-prem in a Multi-node Cluster + - Deploying Kubeflow behind a proxy server + - AWS (remove "Kubeflow on") + - Deployment + - Install Kubeflow + - Uninstall Kubeflow + - Customizing Kubeflow on AWS + - AWS IAM Role for Service Account + - Logging + - Private Access + - Authentication and Authorization + - Authentication using OIDC + - Configure Kubeflow Pipelines on AWS + - Custom Domain + - Optimized Jupyter Notebooks on AWS + - Storage Options + - Configure External Database Using Amazon RDS + - Troubleshooting Deployments on Amazon EKS + - Kubeflow on AWS Features + - End-to-end Kubeflow on AWS + - Azure (remove "Kubeflow on") + - Deployment + - Install Kubeflow + - Initial cluster setup for existing cluster + - Uninstall Kubeflow + - Authentication using OIDC in Azure + - End-to-End Pipeline Example on Azure + - Access Control for Azure Deployment + - Troubleshooting Deployments on Azure AKS + - Google Cloud (remove "Kubeflow on") + - Deploying Kubeflow + - Set up a Google Cloud Project + - Set up OAuth for Cloud IAP + - Management cluster setup + - Deploy using kubectl and kpt + - Monitor Cloud IAP Setup + - Delete using CLI + - Features of Kubeflow on GCP + - Deploy using UI + - Kubeflow On-premises on Anthos GKE + - Pipelines on GCP + - Connecting to Kubeflow Pipelines on Google Cloud using the SDK + - Authenticating Pipelines to GCP + - Upgrading + - Enabling GPU and TPU + - Using Preemptible VMs and GPUs on GCP + - Customizing Kubeflow on GKE + - Using Your Own Domain + - Authenticating Kubeflow to GCP + - Using Cloud Filestore + - Securing Your Clusters + - Troubleshooting Deployments on GKE + - Tutorial: End-to-end Kubeflow on GCP + - Logging and monitoring + - IBM Cloud (remove "Kubeflow on") + - Deployment + - Install Kubeflow + - Securing the Kubeflow authentication with HTTPS + - Uninstall Kubeflow + - Create an IBM Cloud cluster + - Initial cluster setup for existing cluster + - Using IBM Cloud Container Registry (ICR) + - Pipelines on IBM Cloud Kubernetes Service (IKS) + - End-to-end Kubeflow on IBM Cloud + +- **Methods & Distributions** + - kfctl (current `Getting Started/Kubernetes installation`) + - Overview of Deployment on Existing Clusters + - Kubeflow Deployment with kfctl_k8s_istio + - Multi-user, auth-enabled Kubeflow with kfctl_existing_arrikto + - Multi-user, auth-enabled Kubeflow with kfctl_istio_dex + - Configuring Kubeflow with kfctl and kustomize + - kfctl on Minikube (current "Deploying with minikube on a single node") + - Charmed Kubeflow + - Kubeflow on MicroK8s + - MiniKF + - MiniKF on Vagrant (add "on Vagrant") + - MiniKF on GCP (rename "Deploy using MiniKF on GCP") + - MiniKF on AWS (new!) + - OpenShift (remove "Kubeflow on") + - Install Kubeflow on OpenShift + - Uninstall Kubeflow + - Kubeflow Operator + - Introduction + - Installing Kubeflow Operator + - Installing Kubeflow + - Uninstalling Kubeflow + - Uninstalling Kubeflow Operator + - Troubleshooting + +- **Resources** (remove "Tutorials, Samples, and Shared") + - Kubeflow Samples + - Codelabs, Workshops, and Tutorials + - Blog Posts + - Videos + - Shared Resources and Components + +- **Reference** + - Reference Overview + - Kubeflow Versioning Policies + - Dockerfile Locations + - Katib Reference + - MPIJob Reference + - Notebook CRD Reference + - PyTorchJob Reference + - TFJob Reference + +- **Troubleshooting** (created with files from current section "Further Setup and Troubleshooting") + - Frequently Asked Questions + - Troubleshooting + - Usage Reporting + - Support