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.

Sign up for GitHub

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

Jump to bottom

"Getting started" guides should point to 'examples/' rather than have their own individual examples #5799

Closed
ikehz opened this issue Mar 23, 2015 · 11 comments
Closed

"Getting started" guides should point to 'examples/' rather than have their own individual examples #5799

ikehz opened this issue Mar 23, 2015 · 11 comments
Assignees
@caesarxuchao
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.
Milestone
v1.0

Comments

@ikehz
Copy link
Contributor

ikehz commented Mar 23, 2015

I spent a good chunk of last week working through the "Getting started" guide for GCE and the Guestbook example. It seems to me it would be wise to integrate these two resources more.

Right now, the Getting Started with GCE guide has its own example to work through involving Nginx on two containers. The docs would be more maintainable if this instead linked to a universal example, (since it doesn't depend on the provider you're using,) either involving Nginx or not, e.g. the Guestbook example.
@roberthbailey roberthbailey added priority/backlog Higher priority than priority/awaiting-more-evidence. kind/documentation Categorizes issue or PR as related to documentation. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. labels Mar 23, 2015
@bgrant0607 bgrant0607 added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed priority/backlog Higher priority than priority/awaiting-more-evidence. labels Apr 17, 2015
@bgrant0607 bgrant0607 added this to the v1.0 milestone Apr 17, 2015
@bgrant0607
Copy link
Member

Totally agree. We might as well do this as part of #3671 and #6584.

@bgrant0607 bgrant0607 mentioned this issue Apr 17, 2015
Closed
24 tasks
@brendandburns brendandburns self-assigned this Apr 21, 2015
@bgrant0607
Copy link
Member

And we should document this in docs/devel/writing-a-getting-started-guide.md, which we should perhaps move to docs/getting-started-guides

@brendandburns brendandburns mentioned this issue May 1, 2015
Merged
@bgrant0607
Copy link
Member

The GCE guide has been fixed, but many guides still contain API examples.

@bgrant0607 bgrant0607 mentioned this issue May 13, 2015
Closed
16 tasks
@nikhiljindal
Copy link
Contributor

Hi @RichieEscarez,
Wanted to confirm that you are working on this.
Its one of the last remaining tasks for #5475

@RichieEscarez
Copy link
Contributor

Hi @nikhiljindal , yes, ill start on this next.

@bgrant0607 bgrant0607 mentioned this issue May 21, 2015
Merged
@bgrant0607
Copy link
Member

@RichieEscarez We need this done now. Reassigning.

@bgrant0607
Copy link
Member

cc @krousey Feel free to help.

A quick search for v1beta1 shows that the following providers need to be updated:

  • azure
  • mesos
  • juju
  • fedora
  • coreos/bare_metal_offline

This was referenced May 28, 2015
Merged
Closed
Merged
Merged
Merged
@nikhiljindal
Copy link
Contributor

Looks like updating the mesos guide is the only remaining task here.
@caesarxuchao Is that correct?

@caesarxuchao
Copy link
Member

Yes, there is a PR #8882 for mesos.

To be clear, some getting started guides still have their own individual examples, but they are at least updated to v1beta3 now.

@karlkfi karlkfi mentioned this issue Jun 11, 2015
Merged
4 tasks
@goltermann goltermann added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Jun 12, 2015
@bgrant0607
Copy link
Member

Azure.

docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml-28-      printf '{
docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml-29-        "id": "%s",
docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml-30-        "kind": "Minion",
docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml:31:        "apiVersion": "v1beta1",
docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml-32-        "labels": { "environment": "%s" }
docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml-33-        }' "${minion_id}" "${env_label}" \
docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml-34-

@bgrant0607 bgrant0607 mentioned this issue Jun 24, 2015
Closed
@caesarxuchao caesarxuchao mentioned this issue Jun 24, 2015
Merged
@bgrant0607
Copy link
Member

This is done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@caesarxuchao caesarxuchao

Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery.
Projects
None yet
Milestone
v1.0
Development

No branches or pull requests
8 participants
@ikehz @caesarxuchao @brendandburns @bgrant0607 @roberthbailey @goltermann @nikhiljindal @RichieEscarez