-
Notifications
You must be signed in to change notification settings - Fork 773
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merging Requirements and Getting Started page #923
Conversation
Merging requirements.md content into getting-started per issue 845.
Redirecting Requirements page to Getting Started page.
Hi @OfficePop. Thanks for your PR. I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/assign |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for working on this issue.
weight = 1 | ||
+++ | ||
|
||
The guides in this section give detailed information about using Kubeflow and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be helpful to give users an introduction to what this page does. How about something like:
This document provides information about setting up Kubeflow in various environments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the suggestion! I've updated with a commit covering this comment and the next two as well.
The guides in this section give detailed information about using Kubeflow and | ||
its components. | ||
|
||
For best understanding of the guides, it's useful to have some knowledge of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before this sentence it would be good to give this a section header. How about something like:
Before you begin
I would also recommend updating this sentence, since its context has changed. How about something like:
Before you set up your Kubeflow system, it is important to have some knowledge of the following systems and tools:
* [TensorFlow](https://www.tensorflow.org/get_started/) | ||
* [kustomize](https://kustomize.io/) | ||
|
||
## Kubeflow requirements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Assuming that you add a heading similar to "Before you begin", I would recommend adding a # to make this header an H3.
/ok-to-test |
Thanks @OfficePop for this update and @joeliedtke for the review! /lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sarahmaddox 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 |
Merging requirements.md content into getting-started per kubeflow/website issue 845. Changes are as follows:
This change is