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

Rewrote how to choose a getting-started-guide. #11410

Merged
merged 1 commit into from
Jul 17, 2015

Conversation

erictune
Copy link
Member

No description provided.

@k8s-bot
Copy link

k8s-bot commented Jul 17, 2015

GCE e2e build/test passed for commit 3ef2acef673059193552cac602fb26f6b1adb62f.

@erictune
Copy link
Member Author

@thockin @bgrant0607 @RichieEscarez @davidopp

I rewrote docs/getting-started-guide/README.md. It still needs a pass of proofreading, but I thought I would get the general format out there for feedback.

I've switched from having a table as the first thing you see to having prose that helps guide your decision of where to start. I left the table in at the bottom, but I'm thinking of getting rid of it too in a follow-up PR.

I've started replacing "getting started guide" with the word "solution". Here is why:

  • "getting started guide" is a mouthful.
  • I don't want to imply that once you created a cluster, you have gotten started. getting started means really using kubectl to create some pods.

My thought in terms of a left-nav for kubernetes.io is: to have the following items somewhere on the left nav bar:

  • Creating a cluster links to docs/getting-started-guides/README.md
    • Creating a local cluster links to docs/getting-started-guides/README.md#local-solutions
    • Creating a hosted cluster links to docs/getting-started-guides/README.md#hosted-solutions
    • Creating a cluster in the cloud links to docs/getting-started-guides/README.md#turn-key-cloud-solutions
    • Creating a custom cluster links to docs/getting-started-guides/README.md#custom-solutions

@k8s-bot
Copy link

k8s-bot commented Jul 17, 2015

GCE e2e build/test passed for commit 81c71bee623dec236361f89fc1ea3b0589119858.

@bgrant0607
Copy link
Member

Awesome! Thanks much. I think this will help a lot.
LGTM

@bgrant0607 bgrant0607 added kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-merge labels Jul 17, 2015
@bgrant0607 bgrant0607 self-assigned this Jul 17, 2015
@bgrant0607 bgrant0607 added this to the v1.0 milestone Jul 17, 2015
@bgrant0607
Copy link
Member

cc @davidopp for merge

@k8s-bot
Copy link

k8s-bot commented Jul 17, 2015

GCE e2e build/test passed for commit 673fcde51f9024c7e67ab9b46ad1fe3b48248107.

a kubernetes cluster from scratch.

### Local-machine Solutions
These local-machine solutions create a single cluster with one or more kubernetes nodes on a single
Copy link
Member

Choose a reason for hiding this comment

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

What does "These" refer to? Did you mean to point to a doc or docs here?

Copy link
Member

Choose a reason for hiding this comment

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

If you were referring to the ones listed in the next paragraph, then get rid of "Other automated local-machine solutions are:" and just move the bullet list up to merge with this paragraph

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed.

@davidopp
Copy link
Member

I'll leave the ok-to-merge label but please fix the above

@davidopp
Copy link
Member

LGTM

will merge on green

@k8s-bot
Copy link

k8s-bot commented Jul 17, 2015

GCE e2e build/test passed for commit 54cee89.

davidopp added a commit that referenced this pull request Jul 17, 2015
Rewrote how to choose a getting-started-guide.
@davidopp davidopp merged commit f664982 into kubernetes:master Jul 17, 2015
### Local-machine Solutions
Local-machine solutions create a single cluster with one or more kubernetes nodes on a single
physical machine. Setup is completely automated and doesn't require a cloud provider account.
But their size and availability is limited to that of a single machine.
Copy link
Contributor

Choose a reason for hiding this comment

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

Change 'But' to "However, "

#### Integrations
- [Kubernetes on Mesos](mesos.md) (Uses GCE)

## Table of Solutions
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we replace this with a link, move this "table of solutions" to its own document, and say something like:

"See all of the solutions in a table, ordered by last tested/supported product version."

@RichieEscarez
Copy link
Contributor

Thanks Eric. Looks great! Ill update the site nav based on this structure. LGTM pending my comments.

@erictune erictune deleted the matrix branch July 28, 2015 22:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants