Skip to content

Commit 669de15

Browse files
chore: update v1 readme + disallow semantic scopes (#773)
* chore: update readme Signed-off-by: Mathew Wicks <[email protected]> * chore: remove issue templates from non-main branch Signed-off-by: Mathew Wicks <[email protected]> * chore: remove contributing guide from non-main branch Signed-off-by: Mathew Wicks <[email protected]> * chore: disallow commit message scopes Signed-off-by: Mathew Wicks <[email protected]> * chore: move `area/v1` label to root OWNERS Signed-off-by: Mathew Wicks <[email protected]> --------- Signed-off-by: Mathew Wicks <[email protected]>
1 parent 9f95e36 commit 669de15

File tree

13 files changed

+17
-213
lines changed

13 files changed

+17
-213
lines changed

.github/ISSUE_TEMPLATE/01_bug_report.yml

Lines changed: 0 additions & 75 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/02_feature_request.yml

Lines changed: 0 additions & 46 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 0 additions & 13 deletions
This file was deleted.

.github/workflows/OWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
labels:
22
- area/ci
3-
- area/v1

.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: ".*"

CONTRIBUTING.md

Lines changed: 0 additions & 54 deletions
This file was deleted.

OWNERS

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

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Kubeflow Notebooks
1+
# Kubeflow Notebooks - v1
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__.
45

5-
> ⚠️ __Note__ ⚠️
6-
>
7-
> We are currently moving the _Kubeflow Notebooks 1.0_ codebase from [`kubeflow/kubeflow`](https://github.com/kubeflow/kubeflow) to this repository ([`kubeflow/notebooks`](https://github.com/kubeflow/notebooks)).
8-
> Please see [`kubeflow/kubeflow#7549`](https://github.com/kubeflow/kubeflow/issues/7549) for more information.
9-
>
10-
> We are currently developing _Kubeflow Notebooks 2.0_ in this repository under the [`notebooks-v2`](https://github.com/kubeflow/notebooks/tree/notebooks-v2) branch.
11-
> Please see [`kubeflow/notebooks#85`](https://github.com/kubeflow/notebooks/issues/85) for more information.
6+
> [!NOTE]
7+
>
8+
> This repository contains two major versions of Kubeflow Notebooks:
9+
>
10+
> - The `notebooks-v1` branch contains the codebase for _Kubeflow Notebooks v1_.
11+
> - The [`notebooks-v2`](https://github.com/kubeflow/notebooks/tree/notebooks-v2) branch contains the codebase for _Kubeflow Notebooks v2_.
1212
1313
## What is Kubeflow Notebooks?
1414

@@ -21,7 +21,7 @@ Key features of Kubeflow Notebooks:
2121

2222
## Installation
2323

24-
Kubeflow Notebooks is designed to be deployed as part of a [Kubeflow Platform](https://www.kubeflow.org/docs/started/introduction/#what-is-kubeflow-platform) (not as a standalone component).
24+
Kubeflow Notebooks v1 is designed to be deployed as part of a [Kubeflow Platform](https://www.kubeflow.org/docs/started/introduction/#what-is-kubeflow-platform) (not as a standalone component).
2525

2626
Please refer to the [Installing Kubeflow](https://www.kubeflow.org/docs/started/installing-kubeflow/) page for more information.
2727

@@ -40,4 +40,4 @@ Connect with _other users_ and the [Notebooks Working Group](https://github.com/
4040

4141
## Contributing
4242

43-
Please see the [`CONTRIBUTING.md`](CONTRIBUTING.md) file for more information.
43+
Please see the [`CONTRIBUTING.md`](https://github.com/kubeflow/notebooks/blob/main/CONTRIBUTING.md) file for more information.

components/crud-web-apps/OWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
labels:
22
- area/frontend
33
- area/backend
4-
- area/v1
54
approvers:
65
- kimwnasptd
76
- thesuperzapper

components/example-notebook-servers/OWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
labels:
22
- area/server-images
3-
- area/v1
43
approvers:
54
- kimwnasptd
65
- thesuperzapper

0 commit comments

Comments
 (0)