Update contributing page to include additional information

[varodrig]

name: 🧹 Chore
description: Create a Chore on Kubeflow Website

Chore description

As per Kubeflow Trainer PR discussion on having more detailed information about contributions and community per component, I discussed with @andreyvelich about having one centralized page to maintain consistency across the website with this additional information.

Information that needs to be included suggested by Andrey:

• Explain the main principles for the Kubeflow Project contribution
• Explain Kubeflow Membership
• Link to other guides.
• The Kubeflow components guides updated on https://www.kubeflow.org/docs/about/ and linked to the corresponding GitHub repos (this suggestion is followed by the kubernetes website), they are maintaining a general page on website about contributions and community and each project has it's contributions on the repos only. However, discussed with Andrey to include a link to each project contribution on the web page.

Each component has its contribution guidelines on its repository. But this information is not linked on the website. We don't want to duplicate information, but we want to make it more accessible.

Love this idea? Give it a 👍.

[varodrig]

@andreyvelich let me know what you think I made a few updates.

[andreyvelich]

From my point of view, I see the value to have contributor guides under every Kubeflow component for a few reasons:

1. We have users who only read docs for the specific component (Spark Operator, Trainer, Pipelines, etc.)
2. We can have more detailed instruction in these docs for developers of Kubeflow Trainer. For many years we see contributors who only contribute to the individual Kubeflow projects. They don't really know about Kubeflow Platform and other docs.
3. The individual community guide can include detailed information about specific component (that would be overwhelming for the centralized page):
   • Regular Calls
   • Slack
   • Presentation and Blog Posts
   • Other info.

The centralized page for Kubeflow contributions and community is still needed, since it explains the common principles for Kubeflow Community contributions and redirect folks to the above individual guides.

What do community think about it ?
cc @kubeflow/kubeflow-steering-committee @kubeflow/wg-training-leads @kubeflow/wg-pipeline-leads @kubeflow/wg-notebooks-leads @kubeflow/wg-manifests-leads @kubeflow/release-team @kubeflow/wg-data-leads @kubeflow/wg-deployment-leads @franciscojavierarceo

[franciscojavierarceo]

+1 with @andreyvelich's suggestion

[jbottum]

+1 with @andreyvelich suggestion although I would add, we need to be careful about adding more documentation. When it goes out of date, then we get negative feedback. The owners of these pages need to be approving the expected process for future updates i.e. do the docs get updated every release or once a year ?

[juliusvonkohout]

"Each component has its contribution guidelines on its repository. But this information is not linked on the website. " Yes we should rather link such that the maintainers can keep it up to date themselves.

[varodrig]

looking for more comments on this to decide if we move forward with this issue or if we close it.