Commit Graph

10 Commits (c88a07ce1a20ee1de8fc61f02960dae3407146fa)

Author SHA1 Message Date
David McMahon ef0c9f0c5b Remove "All rights reserved" from all the headers. 2016-06-29 17:47:36 -07:00
Eric Paris 8886a9940d Rewrite how the munger works
The basic idea is that in the main mungedocs we run the entirefile and
create an annotated set of lines about that file. All mungers then act
on a struct mungeLines instead of on a bytes array. Making use of the
metadata where appropriete. Helper functions exist to make updating a
'macro block' extremely easy.
2015-07-30 20:41:30 -04:00
Tim Hockin 6e4ec38f51 Make TOC munge include blank line before TOC 2015-07-17 15:06:54 -07:00
Janet Kuo 2498f93938 MUNGE generated table of contents should strip comma 2015-07-16 23:21:09 -07:00
Janet Kuo de755bf59b Make MUNGE generated table of contents (TOC) bookmark work when there are symbols in the headline 2015-07-15 11:26:51 -07:00
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 2e781fed49 Break util func into a new file 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