mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-09-07 04:03:20 +00:00
Run gendocs
This commit is contained in:
@@ -32,6 +32,7 @@ Documentation for other releases can be found at
|
||||
<!-- END MUNGE: UNVERSIONED_WARNING -->
|
||||
|
||||
# Writing a Getting Started Guide
|
||||
|
||||
This page gives some advice for anyone planning to write or update a Getting Started Guide for Kubernetes.
|
||||
It also gives some guidelines which reviewers should follow when reviewing a pull request for a
|
||||
guide.
|
||||
@@ -57,6 +58,7 @@ Distros fall into two categories:
|
||||
There are different guidelines for each.
|
||||
|
||||
## Versioned Distro Guidelines
|
||||
|
||||
These guidelines say *what* to do. See the Rationale section for *why*.
|
||||
- Send us a PR.
|
||||
- Put the instructions in `docs/getting-started-guides/...`. Scripts go there too. This helps devs easily
|
||||
@@ -77,6 +79,7 @@ we still want to hear from you. We suggest you write a blog post or a Gist, and
|
||||
Just file an issue or chat us on IRC and one of the committers will link to it from the wiki.
|
||||
|
||||
## Development Distro Guidelines
|
||||
|
||||
These guidelines say *what* to do. See the Rationale section for *why*.
|
||||
- the main reason to add a new development distro is to support a new IaaS provider (VM and
|
||||
network management). This means implementing a new `pkg/cloudprovider/$IAAS_NAME`.
|
||||
@@ -93,6 +96,7 @@ These guidelines say *what* to do. See the Rationale section for *why*.
|
||||
refactoring and feature additions that affect code for their IaaS.
|
||||
|
||||
## Rationale
|
||||
|
||||
- We want people to create Kubernetes clusters with whatever IaaS, Node OS,
|
||||
configuration management tools, and so on, which they are familiar with. The
|
||||
guidelines for **versioned distros** are designed for flexibility.
|
||||
|
Reference in New Issue
Block a user