Skip to content
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

Merged
merged 8 commits into from
Jul 13, 2019
Merged

Merging Requirements and Getting Started page #923

merged 8 commits into from
Jul 13, 2019

Conversation

OfficePop
Copy link
Contributor

@OfficePop OfficePop commented Jul 12, 2019

Merging requirements.md content into getting-started per kubeflow/website issue 845. Changes are as follows:

  1. Contents from requirements.md were added to getting-started.md. Slight changes to sub-heading information.
  2. Requirements.md was deleted.
  3. A re-direct from requirements.md to getting-started.md was added to _references.

This change is Reviewable

@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@joeliedtke
Copy link
Member

/assign

Copy link
Member

@joeliedtke joeliedtke left a 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
Copy link
Member

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.

Copy link
Contributor Author

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
Copy link
Member

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
Copy link
Member

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.

@sarahmaddox
Copy link
Contributor

/ok-to-test

@sarahmaddox
Copy link
Contributor

Thanks @OfficePop for this update and @joeliedtke for the review!

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit cdbc0a1 into kubeflow:master Jul 13, 2019
@sarahmaddox sarahmaddox added the doc-sprint Issues to work on during the Kubeflow Doc Sprint label Jul 14, 2019
@sarahmaddox sarahmaddox added doc-sprint-2019-07 and removed doc-sprint Issues to work on during the Kubeflow Doc Sprint labels Dec 8, 2019
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