Commit Graph

14 Commits

Author SHA1 Message Date
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
efa76b72ae Run the build once during presubmit 2015-07-02 14:43:43 -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
Eric Paris
6b3a6e6b98 Make copyright ownership statement generic
Instead of saying "Google Inc." (which is not always correct) say "The
Kubernetes Authors", which is generic.
2015-05-01 17:49:56 -04:00
Jeff Lowdermilk
a8e2f6e9c8 Add examples for kubectl describe, and make gendocs less spammy
Makes hack/{run/verify}-gendocs.sh ignore generated-timestamp-only
changes so minor changes to kubectl don't have to touch the entire
set of md docs.
2015-04-23 14:53:10 -07:00
Jeff Lowdermilk
797903798e Suggest running make clean on verify-gendocs failure 2015-04-14 13:21:43 -07:00
Eric Paris
26149bd83d Doc generation should remove old doc files
Right now, our doc generation scripts notice if you make changes and
don't regen docs, don't include new docs, etc.  But they miss it if your
changes should have REMOVED a doc.  Both kubectl-apiversion and
kubectl-clusterinfo should have been removed, but weren't.

This patch starts tracking all generated doc files and will cause
problems if files should be removed and aren't.
2015-04-13 17:48:24 -04:00
Eric Paris
d7a89117b7 Use a helper to find built binaries
Instead of doing it all outselves....
2015-04-13 15:27:55 -04:00
Eric Paris
ebb0affc21 Automatically generate bash completions for kubectl 2015-04-13 15:27:55 -04:00
Eric Paris
263dc981db Use spf13/cobra md generation instead of doing it outselves 2015-04-12 15:03:13 -04:00
Eric Paris
a6beb2e7df Autogenerate md documentation for kubectl
This does away with the giant dump from cobra for kubectl and instead
generates md files which contain similar information, but one per verb.
This might work well as part of the cobra project, instead of doing it
in kube, but this gets us nice, linked, documentation right now.  If
people like it, I will try to get something similar into cobra.
2015-02-12 19:08:57 -05:00
Eric Paris
8e64be1c66 Add godeps for man page autogeneration 2015-02-12 18:38:25 -05:00
Jeff Lowdermilk
c6c46753fd Point to hack/run-gendocs.sh in verify-gendocs.sh error message. 2015-02-03 11:53:30 -08:00
Jeff Lowdermlk
250c948ae7 Autogenerate markdown docs for kubectl
Add test to verify generated docs are up to date.
2015-01-14 13:21:14 -08:00