Commit Graph

60 Commits (0750eaf5330641e8b28bf9ab2307f91cb11e34af)

Author SHA1 Message Date
Eric Tune 950b11f198 Ignore comments in code when generating ToC. 2015-07-13 15:53:05 -07:00
Tim Hockin ad8f8731b6 Use a common set of tag prefixes for munges
All munges now start with `<!-- BEGIN MUNGE:` and end with `<!-- END MUNGE:`.
This lets me (in a followup) filter them better to normalize contents during
verification of generated docs.
2015-07-13 11:23:07 -07:00
Tim Hockin 8fceb754d8 Add 'warning: is unversioned' header to all docs
Mungedocs will keep this updated in head, and it will get stricken from
releases.
2015-07-13 11:23:07 -07:00
Zach Loafman 5c894b765b Fix mungedocs for absolute paths
chdir into the parent of the docs directory, then walk docs.

Fixes #11111
2015-07-11 13:19:55 -07:00
Tim Hockin 8ff8559c4c Add util functions 2015-07-10 17:13:19 -07:00
Tim Hockin 95cd66d3a0 use 'lines []string' for updateMacroBlock 2015-07-10 17:13:19 -07:00
Tim Hockin 2e781fed49 Break util func into a new file 2015-07-10 17:13:19 -07:00
Tim Hockin 84ad1792ea Run all munges on all docs
Rather than terminating, Collect the errors and print them per-file-per-munge.
2015-07-10 17:13:19 -07:00
Daniel Smith c4aab16b04 Adds a link fixer/checker to mungedocs.
Links that don't work yet can be prefixed with "TODO:" to avoid the check.
2015-07-10 10:54:47 -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