|
| 1 | +# Kubeflow Notebooks |
| 2 | + |
| 3 | +[Kubeflow Notebooks](https://www.kubeflow.org/docs/components/notebooks/overview/) lets you run web-based development environments on your Kubernetes cluster by running them inside Pods. |
| 4 | + |
| 5 | +## What is Kubeflow Notebooks? |
| 6 | + |
| 7 | +Key features of Kubeflow Notebooks: |
| 8 | + |
| 9 | +- Native support for [JupyterLab](https://github.com/jupyterlab/jupyterlab), [RStudio](https://github.com/rstudio/rstudio), and [Visual Studio Code (code-server)](https://github.com/coder/code-server). |
| 10 | +- Users can [create notebook containers](https://www.kubeflow.org/docs/components/notebooks/quickstart-guide/) directly in the cluster, rather than locally on their workstations. |
| 11 | +- Admins can provide [standard notebook images](https://www.kubeflow.org/docs/components/notebooks/container-images/) for their organization with required packages pre-installed. |
| 12 | +- Access control is managed by [Kubeflow’s RBAC](https://www.kubeflow.org/docs/components/central-dash/profiles/), enabling easier notebook sharing across the organization. |
| 13 | + |
| 14 | +## Installation |
| 15 | + |
| 16 | +Currently, Kubeflow Notebooks must be deployed as part of a full Kubeflow platform (not as a standalone component). |
| 17 | + |
| 18 | +Please refer to the [Installing Kubeflow](https://www.kubeflow.org/docs/started/installing-kubeflow/) page for more information. |
| 19 | + |
| 20 | +## Documentation |
| 21 | + |
| 22 | +The official documentation for Kubeflow Notebooks can be found [here](https://www.kubeflow.org/docs/components/notebooks/). |
| 23 | + |
| 24 | +## Community |
| 25 | + |
| 26 | +Kubeflow Notebooks is part of the Kubeflow project, refer to the [Kubeflow Community](https://www.kubeflow.org/docs/about/community/) page for more information. |
| 27 | + |
| 28 | +Connect with _other users_ and the [Notebooks Working Group](https://github.com/kubeflow/community/tree/master/wg-notebooks) in the following places: |
| 29 | + |
| 30 | +- [Kubeflow Slack](https://www.kubeflow.org/docs/about/community/#kubeflow-slack) - Join the [`#kubeflow-notebooks`](https://kubeflow.slack.com/archives/CESP7FCQ7) channel. |
| 31 | +- [Kubeflow Mailing List](https://groups.google.com/g/kubeflow-discuss) |
| 32 | + |
| 33 | +## Contributing |
| 34 | + |
| 35 | +We are in the process of moving the Kubeflow Notebooks codebase from [`kubeflow/kubeflow`](https://github.com/kubeflow/kubeflow) to this repository ([`kubeflow/notebooks`](https://github.com/kubeflow/notebooks)). |
| 36 | +For now, please continue to make contributions by raising PRs on `kubeflow/kubeflow`. |
| 37 | + |
| 38 | +Please see the [Contributing to Kubeflow](https://www.kubeflow.org/docs/about/contributing/) page for more information. |
0 commit comments