chore: update main readme + disallow semantic scopes (#772)

* chore: update readme

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* chore: disallow commit message scopes

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

---------

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

Author: thesuperzapper

.github/workflows/semantic-prs.yaml

@@ -17,7 +17,7 @@ jobs:
     name: Validate Title
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@v5.5.3
+      - uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
@@ -32,9 +32,5 @@ jobs:
             docs
             chore
 
-          scopes: |
-            nb
-            pvc
-            tb
-            ws
-          requireScope: false
+          # disallow all commit scopes
+          disallowScopes: ".*"

CONTRIBUTING.md

@@ -35,20 +35,11 @@ A semantic commit message must start with one of the following __prefixes__:
 
 To indicate a breaking change, add `!` after the prefix, e.g. `feat!: my commit message`.
 
-### Scopes
-
-You may optionally include a __scope__ after the prefix, for example:
-
-- `nb` (changes to notebooks - web-app, controller, images)
-- `pvc` (changes to volumes - web-app, controller)
-- `tb` (changes to tensorboards - web-app, controller)
-- `ws` (changes to workspaces - frontend, backend, controller, images)
-
 ### Examples
 
 Here are some examples of semantic commit messages:
 
-- `fix(nb): something that was broken`
-- `feat(ws): a new feature`
+- `fix: something that was broken`
+- `feat: a new feature`
 - `improve: a general improvement`
 - `chore: update readme`

README.md

@@ -1,15 +1,14 @@
 # Kubeflow Notebooks
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9942/badge)](https://www.bestpractices.dev/projects/9942)
 
-[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.
+[Kubeflow Notebooks](https://www.kubeflow.org/docs/components/notebooks/overview/) runs __interactive development environments__ for AI, ML, and Data workloads on __Kubernetes__.
 
-> ⚠️ __Note__ ⚠️
+> [!NOTE]
 >
-> 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)).
-> Please see [`kubeflow/kubeflow#7549`](https://github.com/kubeflow/kubeflow/issues/7549) for more information.
+> This repository contains two major versions of Kubeflow Notebooks:
 >
-> We are currently developing _Kubeflow Notebooks 2.0_ in this repository under the [`notebooks-v2`](https://github.com/kubeflow/notebooks/tree/notebooks-v2) branch.
-> Please see [`kubeflow/notebooks#85`](https://github.com/kubeflow/notebooks/issues/85) for more information.
+> - The [`notebooks-v1`](https://github.com/kubeflow/notebooks/tree/notebooks-v1) branch contains the codebase for _Kubeflow Notebooks v1_.
+> - The [`notebooks-v2`](https://github.com/kubeflow/notebooks/tree/notebooks-v2) branch contains the codebase for _Kubeflow Notebooks v2_.
 
 ## What is Kubeflow Notebooks?
 
@@ -20,12 +19,6 @@ Key features of Kubeflow Notebooks:
 - Admins can provide [standard notebook images](https://www.kubeflow.org/docs/components/notebooks/container-images/) for their organization with required packages pre-installed.
 - Access control is managed by [Kubeflow’s RBAC](https://www.kubeflow.org/docs/components/central-dash/profiles/), enabling easier notebook sharing across the organization.
 
-## Installation
-
-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).
-
-Please refer to the [Installing Kubeflow](https://www.kubeflow.org/docs/started/installing-kubeflow/) page for more information.
-
 ## Documentation
 
 The official documentation for Kubeflow Notebooks can be found [here](https://www.kubeflow.org/docs/components/notebooks/).
@@ -41,4 +34,4 @@ Connect with _other users_ and the [Notebooks Working Group](https://github.com/
 
 ## Contributing
 
-Please see the [`CONTRIBUTING.md`](CONTRIBUTING.md) file for more information.
+Please see the [`CONTRIBUTING.md`](https://github.com/kubeflow/notebooks/blob/main/CONTRIBUTING.md) file for more information.