github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add links to unlinked documents; move making-release-notes.md to docs/devel

Browse Source
This commit is contained in:
Marek Biskup 2015-06-19 17:41:12 +02:00
parent e584629272
commit 7644845b9e
3 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/devel/README.md
View File

@ -6,6 +6,8 @@ Docs in this directory relate to developing Kubernetes.
* **Development Guide** ([development.md](development.md)): Setting up your environment tests. * **Development Guide** ([development.md](development.md)): Setting up your environment tests.
* **Making release notes** ([making-release-notes.md](making-release-notes.md)): Generating release nodes for a new release.
* **Hunting flaky tests** ([flaky-tests.md](flaky-tests.md)): We have a goal of 99.9% flake free tests. * **Hunting flaky tests** ([flaky-tests.md](flaky-tests.md)): We have a goal of 99.9% flake free tests.
Here's how to run your tests many times. Here's how to run your tests many times.

0
docs/making-release-notes.md → docs/devel/making-release-notes.md
View File

15
docs/user-guide.md
View File

@ -58,14 +58,22 @@ kubernetes API, or to contribute directly to the kubernetes project.
* **Glossary** ([glossary.md](glossary.md)): Terms and concepts. * **Glossary** ([glossary.md](glossary.md)): Terms and concepts.
## Further reading ## Further reading
<!--- make sure all documents from the docs directory are linked somewhere.
This one-liner (execute in docs/ dir) prints unlinked documents (only from this
dir - no recursion):
for i in *.md; do grep -r $i . | grep -v "^\./$i" > /dev/null; rv=$?; if [[ $rv -ne 0 ]]; then echo $i; fi; done
-->
* **Annotations** ([annotations.md](annotations.md)): Attaching * **Annotations** ([annotations.md](annotations.md)): Attaching
arbitrary non-identifying metadata. arbitrary non-identifying metadata.
* **Downward API** ([downward_api.md](downward_api.md)): Accessing system
configuration from a pod without accessing Kubernetes API (see also
[container-environment.md](container-environment.md)).
* **Kubernetes Container Environment** ([container-environment.md](container-environment.md)): * **Kubernetes Container Environment** ([container-environment.md](container-environment.md)):
Describes the environment for Kubelet managed containers on a Kubernetes Describes the environment for Kubelet managed containers on a Kubernetes
node. node (see also [downward_api.md](downward_api.md)).
* **DNS Integration with SkyDNS** ([dns.md](dns.md)): * **DNS Integration with SkyDNS** ([dns.md](dns.md)):
Resolving a DNS name directly to a Kubernetes service. Resolving a DNS name directly to a Kubernetes service.
@ -83,6 +91,9 @@ kubernetes API, or to contribute directly to the kubernetes project.
* **Networking** ([networking.md](networking.md)): Pod networking overview. * **Networking** ([networking.md](networking.md)): Pod networking overview.
* **Services and firewalls** ([services-firewalls.md](services-firewalls.md)): How
to use firewalls.
* **The Kubernetes Resource Model** ([resources.md](resources.md)): * **The Kubernetes Resource Model** ([resources.md](resources.md)):
Provides resource information such as size, type, and quantity to assist in Provides resource information such as size, type, and quantity to assist in
assigning Kubernetes resources appropriately. assigning Kubernetes resources appropriately.