@@ -10,7 +10,7 @@ Examples are not:
10
10
* Full app deployments, ready to use, with no explanation. These
11
11
belong to [ Helm charts] ( https://github.com/kubernetes/charts ) .
12
12
* Simple toys to show how to use a Kubernetes feature. These belong in
13
- the [ user guide] ( .. /docs/user-guide /) .
13
+ the [ user guide] ( https://kubernetes.io /docs/home /) .
14
14
* Demos that follow a script to show a Kubernetes feature in
15
15
action. Example: killing a node to demonstrate controller
16
16
self-healing.
@@ -28,8 +28,8 @@ Examples are not:
28
28
commands (TL;DR / quickstart), without cloning the repo (kubectl
29
29
apply -f http://...).
30
30
* Points to documentation of prerequisites.
31
- * [ Create a cluster] ( ../docs/getting-started-guides/ ) (e.g., single-node docker).
32
- * [ Setup kubectl] ( .. /docs/user-guide/prereqs.md ) .
31
+ * [ Create a cluster] ( https://github.com/kubernetes/community/tree/master/contributors/devel/local-cluster ) (e.g., single-node docker).
32
+ * [ Setup kubectl] ( https://kubernetes.io /docs/tasks/tools/install-kubectl/ ) .
33
33
* etc.
34
34
* Should specify which release of Kubernetes is required and any other
35
35
prerequisites, such as DNS, a cloudprovider with PV provisioning, a
@@ -42,21 +42,21 @@ Examples are not:
42
42
### Throughout
43
43
44
44
* Should point to documentation on first mention:
45
- [ kubectl] ( .. /docs/user-guide/kubectl-overview.md ) ,
46
- [ pods] ( .. /docs/user-guide/ pods.md ) ,
47
- [ services] ( .. /docs/user-guide /services.md ) ,
48
- [ deployments] ( .. /docs/user-guide/deployments.md ) ,
49
- [ replication controllers] ( .. /docs/user-guide/replication-controller.md ) ,
50
- [ jobs] ( .. /docs/user-guide/ jobs.md ) ,
51
- [ labels] ( .. /docs/user-guide /labels.md ) ,
52
- [ persistent volumes] ( .. /docs/user-guide/ persistent-volumes.md ) ,
45
+ [ kubectl] ( https://kubernetes.io /docs/user-guide/kubectl-overview/ ) ,
46
+ [ pods] ( https://kubernetes.io /docs/concepts/workloads/ pods/pod/ ) ,
47
+ [ services] ( https://kubernetes.io /docs/concepts /services-networking/service/ ) ,
48
+ [ deployments] ( https://kubernetes.io /docs/concepts/workloads/controllers/deployment/ ) ,
49
+ [ replication controllers] ( https://kubernetes.io /docs/concepts/workloads/controllers/replicationcontroller/ ) ,
50
+ [ jobs] ( https://kubernetes.io /docs/concepts/workloads/controllers/ jobs-run-to-completion/ ) ,
51
+ [ labels] ( https://kubernetes.io /docs/concepts/overview/working-with-objects /labels/ ) ,
52
+ [ persistent volumes] ( https://kubernetes.io /docs/concepts/storage/ persistent-volumes/ ) ,
53
53
etc.
54
54
* Most examples should be cloudprovider-independent (e.g., using PVCs, not PDs).
55
55
* Other examples with cloudprovider-specific bits could be somewhere else.
56
56
* Actually show the app working -- console output, and or screenshots.
57
57
* Ascii animations and screencasts are recommended.
58
- * Follows [ config best practices] ( .. /docs/user-guide/config-best-practices.md ) .
59
- * Shouldn't duplicate the [ thorough walk-through ] ( .. /docs/user-guide/#thorough-walkthrough ) .
58
+ * Follows [ config best practices] ( https://kubernetes.io /docs/concepts/configuration/overview/ ) .
59
+ * Shouldn't duplicate the [ user guide ] ( https://kubernetes.io /docs/home/ ) .
60
60
* Docker images are pre-built, and source is contained in a subfolder.
61
61
* Source is the Dockerfile and any custom files needed beyond the
62
62
upstream app being packaged.
0 commit comments