Skip to content

Commit f2b5a30

Browse files
add README and .gitignore (#1)
Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
1 parent 4ffb27b commit f2b5a30

File tree

3 files changed

+87
-0
lines changed

3 files changed

+87
-0
lines changed

.gitattributes

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# set default to auto
2+
* text=auto
3+
4+
# some of our templates generate linux files, so need LF endings when checked out on windows
5+
*.ini text eol=lf
6+
*.py text eol=lf
7+
*.sh text eol=lf
8+
*.tpl text eol=lf
9+
*.yaml text eol=lf

.gitignore

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## JetBrains
2+
.idea/
3+
*.iml
4+
*.ipr
5+
*.iws
6+
7+
## VSCode
8+
.vscode/*
9+
!.vscode/settings.json
10+
!.vscode/tasks.json
11+
!.vscode/launch.json
12+
!.vscode/extensions.json
13+
*.code-workspace
14+
.history/
15+
16+
## Vim
17+
[._]*.s[a-v][a-z]
18+
[._]*.sw[a-p]
19+
[._]s[a-rt-v][a-z]
20+
[._]ss[a-gi-z]
21+
[._]sw[a-p]
22+
Session.vim
23+
Sessionx.vim
24+
.netrwhist
25+
*~
26+
[._]*.un~
27+
28+
## Emacs
29+
*~
30+
\#*\#
31+
/.emacs.desktop
32+
/.emacs.desktop.lock
33+
*.elc
34+
.\#*
35+
36+
## macOS
37+
.DS_Store
38+
.AppleDouble
39+
.LSOverride
40+
._*

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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

Comments
 (0)