Commit Graph

21 Commits

Author SHA1 Message Date
David McMahon
37787ffe90 Add --norecurse bool to allow mungedocs to process kube root.
Run hack/after-build/update-generated-docs.sh on kube root with --norecurse and
--skip-munges=unversioned-warning.
2016-03-31 16:53:44 -07:00
David McMahon
dae84f5306 Update the latestReleaseBranch to release-1.2 in the munger. 2016-03-08 18:59:28 -08:00
Eric Tune
1ce3081e55 Do not delete text that fails preformat-balance
If preformat lines are unbalanced, do not delete all the lines from there to
end of file.  That might be the only copy of edits made by the user.

Do not print entire file contents for munge errors affecting entire file.
2016-01-11 10:44:10 -08:00
Chao Xu
b728db081b Munger now checks the release branch to verify if a file exist there before
generating a link to it.
2015-12-21 10:40:15 -08:00
Matt Liggett
08418a486d Add debugging output to mungedocs when --verbose=true.
Hope to understand why verify-generated-docs is failing on jenkins but
not here.
2015-11-30 13:43:19 -08:00
Tim Hockin
15e2c62a3e Add a munger check for files that end in preformat 2015-09-25 13:56:50 -07:00
Eric Paris
3c95bd4ee3 Add a whitespace munger
Strips all trailing whitespace from non-preformatted blocks
2015-07-30 20:41:30 -04: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
Mike Danese
0b14613361 Merge pull request #11622 from nikhiljindal/refactormark-new-version
Extracting out the code to versionize docs from mark-new-version and fixing a bunch of issues
2015-07-24 11:32:40 -07:00
nikhiljindal
b0dbb318fe Extract out the versionize docs part in a separate script 2015-07-23 17:56:40 -07:00
Janet Kuo
6778f7f103 Implement mungedocs example syncer 2015-07-20 13:23:19 -07:00
Tim Hockin
aacc4c864c Add a munger for header lines 2015-07-17 15:34:00 -07:00
Daniel Smith
2a112a0004 preformat checker 2015-07-17 11:04:46 -07:00
Tim Hockin
f7512d007b Add munger to verify kubectl -f targets, fix docs 2015-07-16 15:39:45 -07:00
Mike Danese
d4d99deb97 make mungedoc exit 1 if manual changes are needed and wire up erro message. 2015-07-15 11:20:11 -07:00
Daniel Smith
bf77ecc3a9 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-13 17:47:48 -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
698b212491 Run all munges on all docs
Rather than terminating, Collect the errors and print them per-file-per-munge.
2015-07-10 15:33:50 -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