Skip to content

Commit

Permalink
Improve README and GitHub issue templates (#7642)
Browse files Browse the repository at this point in the history 
* Improve README and GitHub issue templates

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

* Use italics instead of bold

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

* Implement suggestions

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

* Remove redundant link on "Kubeflow Components" and make into sentence separate.

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

* Add manifests docs link

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

---------

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
  • Loading branch information
@thesuperzapper
thesuperzapper authored Sep 22, 2024
1 parent f155d87 commit 2b4d95f
Show file tree
Hide file tree
Showing 8 changed files with 137 additions and 80 deletions.
87 changes: 53 additions & 34 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,56 @@ blank_issues_enabled: false
contact_links:
- name: Kubeflow Documentation
url: https://www.kubeflow.org/
about: The official Kubeflow documentation
- name: Issues related to KServe
url: https://github.com/kserve/kserve/issues/new/choose
about: Create issue in kserve/kserve repository
- name: Issues related to Kubeflow Katib
url: https://github.com/kubeflow/katib/issues/new/choose
about: Create issue in kubeflow/katib repository
- name: Issues related to Kubeflow Model Registry
url: https://github.com/kubeflow/model-registry/issues/new/choose
about: Create issue in kubeflow/model-registry repository
- name: Issues related to Kubeflow MPI Operator
url: https://github.com/kubeflow/mpi-operator/issues/new/choose
about: Create issue in kubeflow/mpi-operator repository
- name: Issues related to Kubeflow Notebooks
url: https://github.com/kubeflow/notebooks/issues/new/choose
about: Create issue in kubeflow/notebooks repository
- name: Issues related to Kubeflow Pipelines
url: https://github.com/kubeflow/pipelines/issues/new/choose
about: Create issue in kubeflow/pipelines repository
- name: Issues related to Kubeflow Spark Operator
url: https://github.com/kubeflow/spark-operator/issues/new/choose
about: Create issue in kubeflow/spark-operator repository
- name: Issues related to Kubeflow Training Operator
url: https://github.com/kubeflow/training-operator/issues/new/choose
about: Create issue in kubeflow/training-operator repository
- name: Issues related to Kubeflow Platform Manifests
url: https://github.com/kubeflow/manifests/issues/new/choose
about: Create issue in kubeflow/manifests repository
- name: Issues related to other Kubeflow Platform components
url: https://github.com/kubeflow/dashboard/issues/new/choose
about: Create issue in kubeflow/dashboard repository
- name: Issues related to Kubeflow community or Kubeflow ecosystem
url: https://github.com/kubeflow/community/issues/new/choose
about: Create issue in kubeflow/community repository
about: Official Kubeflow Documentation

- name: Kubeflow Slack
url: https://www.kubeflow.org/docs/about/community/#kubeflow-slack-channels
about: Join the Kubeflow Slack

- name: Issues - Community & Governance
url: https://github.com/kubeflow/community/issues
about: Please use the `kubeflow/community` repository

- name: Issues - KServe
url: https://github.com/kserve/kserve/issues
about: Please use the `kserve/kserve` repository

- name: Issues - Kubeflow Katib
url: https://github.com/kubeflow/katib/issues
about: Please use the `kubeflow/katib` repository

- name: Issues - Kubeflow Model Registry
url: https://github.com/kubeflow/model-registry/issues
about: Please use the `kubeflow/model-registry` repository

- name: Issues - Kubeflow MPI Operator
url: https://github.com/kubeflow/mpi-operator/issues
about: Please use the `kubeflow/mpi-operator` repository

- name: Issues - Kubeflow Notebooks
url: https://github.com/kubeflow/notebooks/issues
about: Please use the `kubeflow/notebooks` repository

- name: Issues - Kubeflow Pipelines
url: https://github.com/kubeflow/pipelines/issues
about: Please use the `kubeflow/pipelines` repository

- name: Issues - Kubeflow Spark Operator
url: https://github.com/kubeflow/spark-operator/issues
about: Please use the `kubeflow/spark-operator` repository

- name: Issues - Kubeflow Training Operator
url: https://github.com/kubeflow/training-operator/issues
about: Please use the `kubeflow/training-operator` repository

- name: Issues - Kubeflow Platform - Central Dashboard
url: https://github.com/kubeflow/dashboard/issues
about: Please use the `kubeflow/dashboard` repository

- name: Issues - Kubeflow Platform - Profile Controller
url: https://github.com/kubeflow/dashboard/issues
about: Please use the `kubeflow/dashboard` repository

- name: Issues - Kubeflow Platform - Kubeflow Manifests
url: https://github.com/kubeflow/manifests/issues
about: Please use the `kubeflow/manifests` repository
8 changes: 7 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# Change Log
# Changelog

The [GitHub Releases](https://github.com/kubeflow/kubeflow/releases) page covers newer versions of `kubeflow/kubeflow` components.

Release information for the overall _Kubeflow Platform_ is available on the [Kubeflow Releases](https://www.kubeflow.org/docs/releases/) page.

# Changelog (pre-0.5.0)

## [v0.5.0-rc.0](https://github.com/kubeflow/kubeflow/tree/v0.5.0-rc.0) (2019-03-28)
[Full Changelog](https://github.com/kubeflow/kubeflow/compare/v0.4.1-rc.4...v0.5.0-rc.0)
Expand Down
13 changes: 3 additions & 10 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
# Kubeflow Contributor Guide

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

The contributor's guide

* shows you where to find the Contributor License Agreement (CLA) that you need
to sign,
* helps you get started with your first contribution to Kubeflow,
* and describes the pull request and review workflow in detail, including the
OWNERS files and automated workflow tool.
Please see our [contributor guide](https://www.kubeflow.org/docs/about/contributing/) for more information on how to get started.
64 changes: 30 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,52 +1,48 @@
<img src="https://www.kubeflow.org/images/logo.svg" width="100">
# Kubeflow

[![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)
[![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)
[![CLOMonitor](https://img.shields.io/endpoint?url=https://clomonitor.io/api/projects/cncf/kubeflow/badge)](https://clomonitor.io/projects/cncf/kubeflow)

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

---
## About Kubeflow

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

Please refer to the official docs at [kubeflow.org](http://kubeflow.org).
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).
Please refer to the official [documentation](https://www.kubeflow.org/docs/) for more information.

## Kubeflow Components

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

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

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

| Component | Source Code |
| -------------------------- | ----------------------------------------------------------------------------- |
| KServe | [`kserve/kserve`](https://github.com/kserve/kserve) |
| Kubeflow Katib | [`kubeflow/katib`](https://github.com/kubeflow/katib) |
| Kubeflow Model Registry | [`kubeflow/model-registry`](https://github.com/kubeflow/model-registry) |
| Kubeflow MPI Operator | [`kubeflow/mpi-operator`](https://github.com/kubeflow/mpi-operator) |
| Kubeflow Notebooks | [`kubeflow/notebooks`](https://github.com/kubeflow/notebooks) |
| Kubeflow Pipelines | [`kubeflow/pipelines`](https://github.com/kubeflow/pipelines) |
| Kubeflow Spark Operator | [`kubeflow/spark-operator`](https://github.com/kubeflow/spark-operator) |
| Kubeflow Training Operator | [`kubeflow/training-operator`](https://github.com/kubeflow/training-operator) |
## Kubeflow Platform

If you want to open issue or pull request for the
[Kubeflow Platform](https://www.kubeflow.org/docs/started/introduction/#what-is-kubeflow-platform)
components:
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.

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

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

## Kubeflow Community
## Kubeflow Community & Contributing

Every Kubeflow component is maintained by Kubeflow working group (WG) leads.
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).

Learn more about Kubeflow community and WG [in this guide](https://www.kubeflow.org/docs/about/community/).
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!
2 changes: 1 addition & 1 deletion ROADMAP.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Kubeflow Roadmap

## Kubeflow 1.9 Release, Planned for release: Jul 2024
## Kubeflow 1.9 Release, Delivered: July 2024
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).

### Themes
Expand Down
15 changes: 15 additions & 0 deletions logo/horizontal.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions logo/icon.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions logo/stacked.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2b4d95f

Please sign in to comment.