Skip to content

Conversation

andreyvelich
Copy link
Member

As part of our effort to put all docs on kubeflow.org website, I made the following changes to the README and docs:

  • Move adopters, roadmap, and contributing guide to the root directory.
  • Remove tfjob and testing guides from docs, since they are out-of-date and not maintained.
  • I will create an issue to move Prometheus monitoring docs to the website.
  • For the release and proposals @kubeflow/wg-training-leads do we want to move them to the root as well ?
    • I moved existing proposals under appropriate KEP directory.
  • For the README I made these updates
    • Update description, similar to the website.
    • Refer to the Kubeflow installation. @kubeflow/wg-training-leads Do we want to keep installation steps in the README or we can just link users to the website guide ?
    • Remove the very old version < 1.4 release of Training Operator, since we migrated to the unified operator 3 years ago.
    • Remove all-in-one proposal from the README.

/hold for review
cc @kubeflow/wg-training-leads @franciscojavierarceo @StefanoFioravanzo @hbelmiro Please let me know what do you think.

Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
Signed-off-by: Andrey Velichkevich <[email protected]>
@google-oss-prow google-oss-prow bot added size/L and removed size/XL labels Sep 9, 2024
@coveralls
Copy link

coveralls commented Sep 9, 2024

Pull Request Test Coverage Report for Build 10777559413

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 10739885471: 0.0%
Covered Lines: 46
Relevant Lines: 46

💛 - Coveralls

README.md Outdated
Please refer to the [getting started guide](https://www.kubeflow.org/docs/components/training/overview/#getting-started)
to quickly create your first Training Operator Job using Python SDK.
Please refer to [the getting started guide](https://www.kubeflow.org/docs/components/training/getting-started/#getting-started-with-pytorchjob)
to quickly create your first distributed training job using Python SDK.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
to quickly create your first distributed training job using Python SDK.
to quickly create your first distributed training job using the Python SDK.

For a complete reference of the custom resource definitions, please refer to the API Definition.

- [TensorFlow API Definition](pkg/apis/kubeflow.org/v1/tensorflow_types.go)
- [PyTorch API Definition](pkg/apis/kubeflow.org/v1/pytorch_types.go)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Copy link
Contributor

@franciscojavierarceo franciscojavierarceo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! one small nit

Signed-off-by: Andrey Velichkevich <[email protected]>
Copy link
Member

@tenzen-y tenzen-y left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks
/lgtm
/approve

Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: franciscojavierarceo, tenzen-y

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@andreyvelich
Copy link
Member Author

Thanks for the review!
/hold cancel

@google-oss-prow google-oss-prow bot merged commit 2cc5dfe into kubeflow:master Sep 10, 2024
39 checks passed
@andreyvelich andreyvelich deleted the improve-readme branch September 10, 2024 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants