Commit Graph

19 Commits

Author SHA1 Message Date
Victor Marmol
b7da593d7c Merge pull request #10762 from erictune/toc
Automatic Doc Editing, with Table of Contents Generation
2015-07-09 08:13:45 -07:00
Eric Tune
c51e35e835 Support for in-place modification of docs
Adds cmd/mungedocs which is framework for processing
all files under docs/ and either verifying that no changes needed or
making in-place changes.

Did not reuse kube::util::gen-docs because that seemed to be
centered around handling added files, and this pass does not
add files.

Planned uses:
 - table of contents automatic updating
 - linkification
 - internal link checker
 - link-path-relativizer or absolutizer
 - example file syncer
 - header inserter.

Just table-of-contents updating in this PR.

Added Table of Contents to docs/networking.md.

Demonstrates use of new TOC generator presubmit.
Other docs will be added in future PRs.
Additional development will be needed to handle some
of the more complex cases.
2015-07-08 14:58:54 -07:00
Tim Hockin
2210220dbf De-dup,overhaul networking docs 2015-07-06 17:28:12 -07:00
Tim Hockin
9fe0d74473 Update networking doc wrt --configure-cbr0 2015-07-06 12:48:59 -07:00
RichieEscarez
899145da10 Replaced (or defined first instance of) GKE/GCE with Google Container Engine/Google Compute Engine
Fixes #10354
2015-06-26 13:30:41 -07:00
Jeff Lowdermilk
553f9f822b Add ga-beacon analytics to gendocs scripts
hack/run-gendocs.sh puts ga-beacon analytics link into all md files,
hack/verify-gendocs.sh verifies presence of link.
2015-05-15 18:56:38 -07:00
Marek Biskup
817049cc73 Broken links fixed. 2015-04-17 11:04:53 +02:00
Michael Bessolov
db51edb767 Update networking.md
Fixed a typo.
2015-03-27 15:40:39 -07:00
Tony Hsu
fe26571157 Fix typo. 2015-03-27 12:55:09 +08:00
Tim Hockin
8c843d638c Add a better networking doc 2015-03-06 16:48:56 -08:00
Meir Fischer
10bf046cc6 Fix grammar 2014-11-09 22:12:55 -05:00
Eric Tune
c47693c0d5 Separated user, dev, and design docs.
Renamed: logging.md -> devel/logging.m
Renamed: access.md -> design/access.md
Renamed: identifiers.md -> design/identifiers.md
Renamed:    labels.md -> design/labels.md
Renamed:    namespaces.md -> design/namespaces.md
Renamed:    security.md -> design/security.md
Renamed:    networking.md -> design/networking.md

Added abbreviated user user-focused document in place of most moved docs.

Added docs/README.md explains how docs are organized.
Added short, user-oriented documentation on labels
Added a glossary.
Fixed up some links.
2014-10-31 08:35:53 -07:00
Tim Hockin
d258eca6fd Add and update docs. 2014-10-16 08:36:47 -07:00
Matt T. Proud
8a911b39af Swap internal doc. refs to relative links.
This commit addresses issue #1571, which requests that all internal
Kubernetes links are swapped to relative ones to better facilitate
browsing of documentation on local forks, not to mention make the
documentation have less needless boilerplate.
2014-10-08 21:09:18 +02:00
Yves Junqueira
aab58c8033 Rudder has been renamed to Flannel. Update doc references.
See: 81dac46496
2014-09-19 00:36:54 +02:00
Rajat Chopra
07d1c6ff44 ovs networking document
Update networking.md
2014-09-08 17:06:25 -07:00
CJ Cullen
4a2c3c8c87 Fixed some typos:
Changed "an unified" to "a unified"
Changed "a extra" to "an extra"
Changed "for each pod have" to "for each pod to have"
2014-09-03 14:03:33 -07:00
Jonathan Boulle
a8353feb25 Fix a few other doc typos 2014-07-19 21:57:07 -07:00
Brian Grant
37fb72d295 Add networking documentation from issue #188. Refactor pod, label, and networking documentation to push details into separate documents. Add some documentation of how to connect to services. 2014-07-16 18:04:35 +00:00