Skip to content

Commit 2b4d95f

Browse files
Improve README and GitHub issue templates (#7642)
* Improve README and GitHub issue templates Signed-off-by: Mathew Wicks <[email protected]> * Use italics instead of bold Signed-off-by: Mathew Wicks <[email protected]> * Implement suggestions Signed-off-by: Mathew Wicks <[email protected]> * Remove redundant link on "Kubeflow Components" and make into sentence separate. Signed-off-by: Mathew Wicks <[email protected]> * Add manifests docs link Signed-off-by: Mathew Wicks <[email protected]> --------- Signed-off-by: Mathew Wicks <[email protected]>
1 parent f155d87 commit 2b4d95f

File tree

8 files changed

+137
-80
lines changed

8 files changed

+137
-80
lines changed

.github/ISSUE_TEMPLATE/config.yml

+53-34
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,56 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Kubeflow Documentation
44
url: https://www.kubeflow.org/
5-
about: The official Kubeflow documentation
6-
- name: Issues related to KServe
7-
url: https://github.com/kserve/kserve/issues/new/choose
8-
about: Create issue in kserve/kserve repository
9-
- name: Issues related to Kubeflow Katib
10-
url: https://github.com/kubeflow/katib/issues/new/choose
11-
about: Create issue in kubeflow/katib repository
12-
- name: Issues related to Kubeflow Model Registry
13-
url: https://github.com/kubeflow/model-registry/issues/new/choose
14-
about: Create issue in kubeflow/model-registry repository
15-
- name: Issues related to Kubeflow MPI Operator
16-
url: https://github.com/kubeflow/mpi-operator/issues/new/choose
17-
about: Create issue in kubeflow/mpi-operator repository
18-
- name: Issues related to Kubeflow Notebooks
19-
url: https://github.com/kubeflow/notebooks/issues/new/choose
20-
about: Create issue in kubeflow/notebooks repository
21-
- name: Issues related to Kubeflow Pipelines
22-
url: https://github.com/kubeflow/pipelines/issues/new/choose
23-
about: Create issue in kubeflow/pipelines repository
24-
- name: Issues related to Kubeflow Spark Operator
25-
url: https://github.com/kubeflow/spark-operator/issues/new/choose
26-
about: Create issue in kubeflow/spark-operator repository
27-
- name: Issues related to Kubeflow Training Operator
28-
url: https://github.com/kubeflow/training-operator/issues/new/choose
29-
about: Create issue in kubeflow/training-operator repository
30-
- name: Issues related to Kubeflow Platform Manifests
31-
url: https://github.com/kubeflow/manifests/issues/new/choose
32-
about: Create issue in kubeflow/manifests repository
33-
- name: Issues related to other Kubeflow Platform components
34-
url: https://github.com/kubeflow/dashboard/issues/new/choose
35-
about: Create issue in kubeflow/dashboard repository
36-
- name: Issues related to Kubeflow community or Kubeflow ecosystem
37-
url: https://github.com/kubeflow/community/issues/new/choose
38-
about: Create issue in kubeflow/community repository
5+
about: Official Kubeflow Documentation
6+
7+
- name: Kubeflow Slack
8+
url: https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels
9+
about: Join the Kubeflow Slack
10+
11+
- name: Issues - Community & Governance
12+
url: https://github.com/kubeflow/community/issues
13+
about: Please use the `kubeflow/community` repository
14+
15+
- name: Issues - KServe
16+
url: https://github.com/kserve/kserve/issues
17+
about: Please use the `kserve/kserve` repository
18+
19+
- name: Issues - Kubeflow Katib
20+
url: https://github.com/kubeflow/katib/issues
21+
about: Please use the `kubeflow/katib` repository
22+
23+
- name: Issues - Kubeflow Model Registry
24+
url: https://github.com/kubeflow/model-registry/issues
25+
about: Please use the `kubeflow/model-registry` repository
26+
27+
- name: Issues - Kubeflow MPI Operator
28+
url: https://github.com/kubeflow/mpi-operator/issues
29+
about: Please use the `kubeflow/mpi-operator` repository
30+
31+
- name: Issues - Kubeflow Notebooks
32+
url: https://github.com/kubeflow/notebooks/issues
33+
about: Please use the `kubeflow/notebooks` repository
34+
35+
- name: Issues - Kubeflow Pipelines
36+
url: https://github.com/kubeflow/pipelines/issues
37+
about: Please use the `kubeflow/pipelines` repository
38+
39+
- name: Issues - Kubeflow Spark Operator
40+
url: https://github.com/kubeflow/spark-operator/issues
41+
about: Please use the `kubeflow/spark-operator` repository
42+
43+
- name: Issues - Kubeflow Training Operator
44+
url: https://github.com/kubeflow/training-operator/issues
45+
about: Please use the `kubeflow/training-operator` repository
46+
47+
- name: Issues - Kubeflow Platform - Central Dashboard
48+
url: https://github.com/kubeflow/dashboard/issues
49+
about: Please use the `kubeflow/dashboard` repository
50+
51+
- name: Issues - Kubeflow Platform - Profile Controller
52+
url: https://github.com/kubeflow/dashboard/issues
53+
about: Please use the `kubeflow/dashboard` repository
54+
55+
- name: Issues - Kubeflow Platform - Kubeflow Manifests
56+
url: https://github.com/kubeflow/manifests/issues
57+
about: Please use the `kubeflow/manifests` repository

CHANGELOG.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Change Log
1+
# Changelog
2+
3+
The [GitHub Releases](https://github.com/kubeflow/kubeflow/releases) page covers newer versions of `kubeflow/kubeflow` components.
4+
5+
Release information for the overall _Kubeflow Platform_ is available on the [Kubeflow Releases](https://www.kubeflow.org/docs/releases/) page.
6+
7+
# Changelog (pre-0.5.0)
28

39
## [v0.5.0-rc.0](https://github.com/kubeflow/kubeflow/tree/v0.5.0-rc.0) (2019-03-28)
410
[Full Changelog](https://github.com/kubeflow/kubeflow/compare/v0.4.1-rc.4...v0.5.0-rc.0)

CONTRIBUTING.md

+3-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
# Kubeflow Contributor Guide
22

3-
Welcome to the Kubeflow project! We'd love to accept your patches and
4-
contributions to this project. Please read the
5-
[contributor's guide in our docs](https://www.kubeflow.org/docs/about/contributing/).
3+
Welcome to the Kubeflow project!
4+
We'd love to accept your patches and contributions to this project.
65

7-
The contributor's guide
8-
9-
* shows you where to find the Contributor License Agreement (CLA) that you need
10-
to sign,
11-
* helps you get started with your first contribution to Kubeflow,
12-
* and describes the pull request and review workflow in detail, including the
13-
OWNERS files and automated workflow tool.
6+
Please see our [contributor guide](https://www.kubeflow.org/docs/about/contributing/) for more information on how to get started.

README.md

+30-34
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,48 @@
1-
<img src="https://www.kubeflow.org/images/logo.svg" width="100">
1+
# Kubeflow
22

3-
[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels)
3+
[![Join Kubeflow Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels)
44
[![CLOMonitor](https://img.shields.io/endpoint?url=https://clomonitor.io/api/projects/cncf/kubeflow/badge)](https://clomonitor.io/projects/cncf/kubeflow)
55

6-
The Kubeflow makes AI/ML on Kubernetes simple, portable and scalable.
6+
<img src="./logo/icon.svg" width="120">
77

8-
---
8+
## About Kubeflow
99

10-
## Documentation
10+
[Kubeflow](https://www.kubeflow.org/) makes artificial intelligence and machine learning simple, portable, and scalable.
1111

12-
Please refer to the official docs at [kubeflow.org](http://kubeflow.org).
12+
We are an _ecosystem_ of [Kubernetes](https://kubernetes.io/) based components for each stage in the [AI/ML Lifecycle](https://www.kubeflow.org/docs/started/architecture/#kubeflow-components-in-the-ml-lifecycle) with support for best-in-class open source [tools and frameworks](https://www.kubeflow.org/docs/started/architecture/#kubeflow-ecosystem).
13+
Please refer to the official [documentation](https://www.kubeflow.org/docs/) for more information.
1314

1415
## Kubeflow Components
1516

16-
The Kubeflow ecosystem is composed of multiple open-source projects for each stage in
17-
[the ML lifecycle](https://www.kubeflow.org/docs/started/architecture/#kubeflow-components-in-the-ml-lifecycle).
17+
The [Kubeflow Ecosystem](https://www.kubeflow.org/docs/started/architecture/#kubeflow-ecosystem) is composed of several projects known as _Kubeflow Components_.
1818

19-
Learn more about each project in [the Kubeflow documentation](https://www.kubeflow.org/docs/components/).
19+
The following table lists the components and their respective source code repositories:
2020

21-
Please use the following GitHub repositories to open issues and pull requests for
22-
[the different Kubeflow components](https://www.kubeflow.org/docs/started/introduction/#what-are-standalone-kubeflow-components):
21+
| Component | Source Code |
22+
|---------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
23+
| [KServe](https://www.kubeflow.org/docs/external-add-ons/kserve/) | [`kserve/kserve`](https://github.com/kserve/kserve) |
24+
| [Kubeflow Katib](https://www.kubeflow.org/docs/components/katib/) | [`kubeflow/katib`](https://github.com/kubeflow/katib) |
25+
| [Kubeflow Model Registry](https://www.kubeflow.org/docs/components/model-registry/) | [`kubeflow/model-registry`](https://github.com/kubeflow/model-registry) |
26+
| [Kubeflow MPI Operator](https://www.kubeflow.org/docs/components/training/user-guides/mpi/) | [`kubeflow/mpi-operator`](https://github.com/kubeflow/mpi-operator) |
27+
| [Kubeflow Notebooks](https://www.kubeflow.org/docs/components/notebooks/) | [`kubeflow/notebooks`](https://github.com/kubeflow/notebooks) |
28+
| [Kubeflow Pipelines](https://www.kubeflow.org/docs/components/pipelines/) | [`kubeflow/pipelines`](https://github.com/kubeflow/pipelines) |
29+
| [Kubeflow Spark Operator](https://www.kubeflow.org/docs/components/spark-operator/) | [`kubeflow/spark-operator`](https://github.com/kubeflow/spark-operator) |
30+
| [Kubeflow Training Operator](https://www.kubeflow.org/docs/components/training/) | [`kubeflow/training-operator`](https://github.com/kubeflow/training-operator) |
2331

24-
| Component | Source Code |
25-
| -------------------------- | ----------------------------------------------------------------------------- |
26-
| KServe | [`kserve/kserve`](https://github.com/kserve/kserve) |
27-
| Kubeflow Katib | [`kubeflow/katib`](https://github.com/kubeflow/katib) |
28-
| Kubeflow Model Registry | [`kubeflow/model-registry`](https://github.com/kubeflow/model-registry) |
29-
| Kubeflow MPI Operator | [`kubeflow/mpi-operator`](https://github.com/kubeflow/mpi-operator) |
30-
| Kubeflow Notebooks | [`kubeflow/notebooks`](https://github.com/kubeflow/notebooks) |
31-
| Kubeflow Pipelines | [`kubeflow/pipelines`](https://github.com/kubeflow/pipelines) |
32-
| Kubeflow Spark Operator | [`kubeflow/spark-operator`](https://github.com/kubeflow/spark-operator) |
33-
| Kubeflow Training Operator | [`kubeflow/training-operator`](https://github.com/kubeflow/training-operator) |
32+
## Kubeflow Platform
3433

35-
If you want to open issue or pull request for the
36-
[Kubeflow Platform](https://www.kubeflow.org/docs/started/introduction/#what-is-kubeflow-platform)
37-
components:
34+
The [Kubeflow Platform](https://www.kubeflow.org/docs/started/introduction/#what-is-kubeflow-platform) refers to the full suite of Kubeflow Components bundled together with additional integration and management tools.
3835

39-
- Use the [`kubeflow/manifests`](https://github.com/kubeflow/manifests) GitHub repository for
40-
the Kubeflow Manifests.
41-
- Use the [`kubeflow/dashboard`](https://github.com/kubeflow/dashboard) GitHub repository for
42-
the Kubeflow Profile Controller, Central Dashboard, CRUD Web Apps, PVC Viewer, PodDefault, and
43-
Access Management components.
36+
The following table lists the platform components and their respective source code repositories:
4437

45-
If you have questions about Kubeflow community or Kubeflow ecosystem, please use the
46-
[`kubeflow/community`](https://github.com/kubeflow/community) GitHub repository.
38+
| Component | Source Code |
39+
|-----------------------------------------------------------------------------------------------------|---------------------------------------------------------------|
40+
| [Central Dashboard](https://www.kubeflow.org/docs/components/central-dash/) | [`kubeflow/dashboard`](https://github.com/kubeflow/dashboard) |
41+
| [Profile Controller](https://www.kubeflow.org/docs/components/central-dash/profiles/) | [`kubeflow/dashboard`](https://github.com/kubeflow/dashboard) |
42+
| [Kubeflow Manifests](https://www.kubeflow.org/docs/started/installing-kubeflow/#kubeflow-manifests) | [`kubeflow/manifests`](https://github.com/kubeflow/manifests) |
4743

48-
## Kubeflow Community
44+
## Kubeflow Community & Contributing
4945

50-
Every Kubeflow component is maintained by Kubeflow working group (WG) leads.
46+
Kubeflow is a community-lead project maintained by the [Kubeflow Working Groups](https://www.kubeflow.org/docs/about/community/#kubeflow-working-groups) under the guidance of the [Kubeflow Steering Committee](https://github.com/kubeflow/community/blob/master/KUBEFLOW-STEERING-COMMITTEE.md).
5147

52-
Learn more about Kubeflow community and WG [in this guide](https://www.kubeflow.org/docs/about/community/).
48+
We encourage you to learn about the [Kubeflow Community](https://www.kubeflow.org/docs/about/community/) and how to [contribute](https://www.kubeflow.org/docs/about/contributing/) to the project!

ROADMAP.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Kubeflow Roadmap
22

3-
## Kubeflow 1.9 Release, Planned for release: Jul 2024
3+
## Kubeflow 1.9 Release, Delivered: July 2024
44
The Kubeflow Community plans to deliver its v1.9 release in Jul 2024 per this [timeline](https://github.com/kubeflow/community/blob/master/releases/release-1.9/README.md#timeline). The high level deliverables are tracked in the [v1.9 Release](https://github.com/orgs/kubeflow/projects/61) Github project board. The v1.9 release process will be managed by the v1.9 [release team](https://github.com/kubeflow/community/blob/master/releases/release-1.9/release-team.md) using the best practices in the [Release Handbook](https://github.com/kubeflow/community/blob/master/releases/handbook.md).
55

66
### Themes

logo/horizontal.svg

+15
Loading

logo/icon.svg

+13
Loading

logo/stacked.svg

+15
Loading

0 commit comments

Comments
 (0)