Commit Graph

25 Commits

Author SHA1 Message Date
Tim Hockin
3c93febeb8 Fix the munger for code blocks - ticks at start of line 2015-07-21 10:23:54 -07:00
Tim Hockin
a9b7db0df7 Add a munger for header lines 2015-07-21 10:23:53 -07:00
Tim Hockin
0b826158a3 Make TOC munge include blank line before TOC 2015-07-21 10:23:52 -07:00
Daniel Smith
69288979b8 fix util_test.go 2015-07-21 10:23:52 -07:00
Daniel Smith
4ca427e5a9 fix unversioned test 2015-07-21 10:23:52 -07:00
Daniel Smith
c1e3153258 preformat checker 2015-07-21 10:23:51 -07:00
Tim Hockin
c89265d138 Better scary message 2015-07-21 10:23:50 -07:00
Janet Kuo
3b29e39e98 MUNGE generated table of contents should strip comma 2015-07-21 10:23:50 -07:00
Daniel Smith
7795a7a362 absolute link checking 2015-07-21 10:23:49 -07:00
Tim Hockin
b8378c2ea0 Add munger to verify kubectl -f targets, fix docs 2015-07-21 10:23:49 -07:00
Janet Kuo
a9af57cec0 Make MUNGE generated table of contents (TOC) bookmark work when there are symbols in the headline 2015-07-21 10:23:46 -07:00
Mike Danese
6badb7575e make mungedoc exit 1 if manual changes are needed and wire up erro message. 2015-07-21 10:23:46 -07:00
Tim Hockin
7e68005fee Change warning.png to not go through a redirect 2015-07-21 10:23:43 -07:00
Tim Hockin
384b2fddb6 Add an image to unversioned warnings 2015-07-21 10:23:43 -07:00
Daniel Smith
4db0a4cb2d Various munger changes
* Add analytics munger w/ munge heading
* More link autofixes
* Allow running a subset of munges
* Fix repo root detection
* Only process non-preformatted blocks
* Gendocs no longer adds the analytics link; mungedocs does that in a
  second pass.
2015-07-21 10:23:40 -07:00
Eric Tune
ab280f5ec7 Ignore comments in code when generating ToC. 2015-07-21 10:23:39 -07:00
Tim Hockin
0724f413ad 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-21 10:23:36 -07:00
Tim Hockin
44e39636ba Add 'warning: is unversioned' header to all docs
Mungedocs will keep this updated in head, and it will get stricken from
releases.
2015-07-21 10:23:36 -07:00
Zach Loafman
b9f62bcb04 Fix mungedocs for absolute paths
chdir into the parent of the docs directory, then walk docs.

Fixes #11111
2015-07-11 13:43:34 -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