Skip to content

Commit b02953a

Browse files
chore: update v2 readme + disallow semantic scopes (#774)
* chore: update readme Signed-off-by: Mathew Wicks <[email protected]> * chore: disallow commit message scopes Signed-off-by: Mathew Wicks <[email protected]> * chore: move `area/v2` label to root OWNERS Signed-off-by: Mathew Wicks <[email protected]> --------- Signed-off-by: Mathew Wicks <[email protected]>
1 parent 8e2609f commit b02953a

File tree

7 files changed

+22
-24
lines changed

7 files changed

+22
-24
lines changed

.github/workflows/OWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
labels:
22
- area/ci
3-
- area/v2
43
approvers:
54
- andyatmiami

.github/workflows/semantic-prs.yaml

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
name: Validate Title
1818
runs-on: ubuntu-latest
1919
steps:
20-
- uses: amannn/action-semantic-pull-request@v5.5.3
20+
- uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1
2121
env:
2222
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2323
with:
@@ -32,9 +32,5 @@ jobs:
3232
docs
3333
chore
3434
35-
scopes: |
36-
nb
37-
pvc
38-
tb
39-
ws
40-
requireScope: false
35+
# disallow all commit scopes
36+
disallowScopes: ".*"

OWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
labels:
2+
- area/v2
13
approvers:
24
- kimwnasptd
35
- thesuperzapper

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
# Kubeflow Notebooks
1+
# Kubeflow Notebooks - v2
2+
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9942/badge)](https://www.bestpractices.dev/projects/9942)
23

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+
[Kubeflow Notebooks](https://www.kubeflow.org/docs/components/notebooks/overview/) runs __interactive development environments__ for AI, ML, and Data workloads on __Kubernetes__.
5+
6+
> [!NOTE]
7+
>
8+
> This repository contains two major versions of Kubeflow Notebooks:
9+
>
10+
> - The [`notebooks-v1`](https://github.com/kubeflow/notebooks/tree/notebooks-v1) branch contains the codebase for _Kubeflow Notebooks v1_.
11+
> - The `notebooks-v2` branch contains the codebase for _Kubeflow Notebooks v2_.
412
513
## What is Kubeflow Notebooks?
614

@@ -13,9 +21,10 @@ Key features of Kubeflow Notebooks:
1321

1422
## Installation
1523

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.
24+
> [!WARNING]
25+
>
26+
> Kubeflow Notebooks v2 is __not yet released__. We are actively developing the first stable release and will share updates soon.
27+
> See [`kubeflow/notebooks#85`](https://github.com/kubeflow/notebooks/issues/85) for more details.
1928
2029
## Documentation
2130

@@ -25,16 +34,11 @@ The official documentation for Kubeflow Notebooks can be found [here](https://ww
2534

2635
Kubeflow Notebooks is part of the Kubeflow project, refer to the [Kubeflow Community](https://www.kubeflow.org/docs/about/community/) page for more information.
2736

28-
Connect with _other users_ and the [Notebooks Working Group](https://github.com/kubeflow/community/tree/master/wg-notebooks) in the following places:
37+
Connect with _other users_ and the [Notebooks Working Group](https://github.com/kubeflow/community/tree/master/wg-notebooks) (maintainers of Kubeflow Notebooks) in the following places:
2938

30-
- [Kubeflow Slack](https://www.kubeflow.org/docs/about/community/#kubeflow-slack) - Join the [`#kubeflow-notebooks`](https://kubeflow.slack.com/archives/CESP7FCQ7) channel.
39+
- [Kubeflow Slack](https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels) - Join the [`#kubeflow-notebooks`](https://cloud-native.slack.com/archives/C073W562HFY) channel.
3140
- [Kubeflow Mailing List](https://groups.google.com/g/kubeflow-discuss)
3241

3342
## Contributing
3443

35-
> ⚠️ __Note__ ⚠️
36-
>
37-
> We are currently moving the Kubeflow Notebooks codebase from [`kubeflow/kubeflow`](https://github.com/kubeflow/kubeflow) to this repository ([`kubeflow/notebooks`](https://github.com/kubeflow/notebooks)).
38-
> For now, please continue to make contributions by raising PRs on `kubeflow/kubeflow`.
39-
40-
Please see the [Contributing to Kubeflow](https://www.kubeflow.org/docs/about/contributing/) page for more information.
44+
Please see the [`CONTRIBUTING.md`](https://github.com/kubeflow/notebooks/blob/main/CONTRIBUTING.md) file for more information.

workspaces/backend/OWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
labels:
22
- area/backend
3-
- area/v2
43
approvers:
54
- andyatmiami

workspaces/controller/OWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
labels:
22
- area/controller
3-
- area/v2
43
approvers:
54
- andyatmiami

workspaces/frontend/OWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
labels:
22
- area/frontend
3-
- area/v2
43
approvers:
54
- ederign
65
- paulovmr

0 commit comments

Comments
 (0)