github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
23,946 Commits
32 Branches
881 Tags
633 MiB
Commit Graph

46 Commits (8bab0022ad48e45be7bfc2981ea92ae5c85b83d1)

Author SHA1 Message Date
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
Mike Danese 1934fc73e8 mungedocs: fix ignored errors in link checker 
Before this change the link checker would ignore errors in a file if
the last link in a file was correct. The last link would wipe out the
error variable and set it to nil. Furthermore, it replaced errored
links with the empty string.

If we find an error that we can't correct, append the error message to
an an errs slice and leave the string as is.

Signed-off-by: Mike Danese <mikedanese@google.com>
 2016-01-05 12:58:30 -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
Eric Tune 21f81935e2 examples munger allows any file extension. 2015-12-07 14:18:42 -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 938f80b683 Change 'scary warning' to point to v1.1 2015-11-13 13:49:43 -08:00
Tim Hockin 15e2c62a3e Add a munger check for files that end in preformat 2015-09-25 13:56:50 -07:00
Carsten Clasohm d093fe0c4b add raw flag for GitHub download links 2015-09-07 17:43:09 -07:00
Mike Danese 5caf5e0191 point mugnedocs at new organization 2015-08-12 16:37:43 -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
Eric Paris 4cbca2e63c Make munger begin/end less generic 
Just force the beginMungeTag() endMungeTag() macros on users, by hiding
it under the covers. It really simplies things for users.
 2015-07-30 20:41:30 -04:00
Eric Paris 22fd8ac32d Speed up mungedoc TOC by pre-compiling a regex 
Brings the time to run the TOC over the docs directory from .7 seconds
to .1 seconds
 2015-07-30 20:41:29 -04:00
Ilya Dmitrichenko 5e7a6a8b89 Ignore home directory paths 2015-07-28 22:02:49 +01:00
Janet Kuo 180798cfa4 Use example syncer tags instead of hard-coded examples in doc 2015-07-27 14:48:41 -07: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 8172551763 Fix the munger for code blocks - ticks at start of line 2015-07-18 14:06:08 -07:00
David Oppenheimer d28a6656ae Merge pull request #11452 from thockin/docs-munge-headerlines 
Munge headerlines
 2015-07-17 15:52:08 -07:00
Tim Hockin aacc4c864c Add a munger for header lines 2015-07-17 15:34:00 -07:00
Tim Hockin 6e4ec38f51 Make TOC munge include blank line before TOC 2015-07-17 15:06:54 -07:00
Daniel Smith 2c046685f6 fix util_test.go 2015-07-17 12:02:35 -07:00
Daniel Smith b563bb3760 fix unversioned test 2015-07-17 11:58:50 -07:00
Daniel Smith 2a112a0004 preformat checker 2015-07-17 11:04:46 -07:00
Tim Hockin 542e13d2d3 Better scary message 2015-07-17 09:28:49 -07:00
Janet Kuo 2498f93938 MUNGE generated table of contents should strip comma 2015-07-16 23:21:09 -07:00
Brian Grant 786b59427d Merge pull request #11400 from lavalamp/munger 
Add absolute path link checking to munger
 2015-07-16 22:50:14 -07:00
Daniel Smith 4d1bf3a0ca absolute link checking 2015-07-16 16:23:19 -07:00
Tim Hockin f7512d007b Add munger to verify kubectl -f targets, fix docs 2015-07-16 15:39:45 -07:00
Eric Tune f1c7915d71 Merge pull request #11325 from JanetKuo/toc 
Make MUNGE generated TOC bookmark work for symbols
 2015-07-15 12:56:37 -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
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
Tim Hockin 6277801f82 Change warning.png to not go through a redirect 2015-07-14 17:28:10 -07:00
Tim Hockin c4953c6287 Add an image to unversioned warnings 2015-07-14 15:28:59 -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
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