Skip to content

Commit 15e88c6

Browse files
committed
Fix links in guidelines after docs move
1 parent e00514b commit 15e88c6

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

guidelines.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Examples are not:
1010
* Full app deployments, ready to use, with no explanation. These
1111
belong to [Helm charts](https://github.com/kubernetes/charts).
1212
* 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/).
1414
* Demos that follow a script to show a Kubernetes feature in
1515
action. Example: killing a node to demonstrate controller
1616
self-healing.
@@ -28,8 +28,8 @@ Examples are not:
2828
commands (TL;DR / quickstart), without cloning the repo (kubectl
2929
apply -f http://...).
3030
* 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/).
3333
* etc.
3434
* Should specify which release of Kubernetes is required and any other
3535
prerequisites, such as DNS, a cloudprovider with PV provisioning, a
@@ -42,21 +42,21 @@ Examples are not:
4242
### Throughout
4343

4444
* 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/),
5353
etc.
5454
* Most examples should be cloudprovider-independent (e.g., using PVCs, not PDs).
5555
* Other examples with cloudprovider-specific bits could be somewhere else.
5656
* Actually show the app working -- console output, and or screenshots.
5757
* 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/).
6060
* Docker images are pre-built, and source is contained in a subfolder.
6161
* Source is the Dockerfile and any custom files needed beyond the
6262
upstream app being packaged.

0 commit comments

Comments
 (0)