Remove update/verify-munge-docs.sh

[caesarxuchao]

These scripts are no long needed because:

1. most docs are moved to other repos
2. the mungers are pre-processing the docs for gh pages, which are created with a whole different process now.

cc @bgrant0607 @thockin

[k8s-reviewable]

This change is 

[grodrigues3]

i'll add lgtm once tests pass

[bgrant0607]

Our goal is to move all significant docs and examples out of the main repo. We no longer publish docs from this repo to github pages. The verify script is mostly a hindrance at this point. So, we're nuking it.

FYI: @lavalamp @pwittrock @devin-donnelly @jaredbhatti @jeffmendoza @viglesiasce @david-mcmahon @ixdy

[bgrant0607]

/lgtm

[k8s-ci-robot]

@bgrant0607: you can't LGTM a PR unless you are assigned as a reviewer.

In response to this comment:

/lgtm

If you have questions or suggestions related to this bot's behavior, please file an issue against the kubernetes/test-infra repository.

[thockin]

should we nix the gh-pages branch now?

…

On Wed, Dec 7, 2016 at 1:23 PM, k8s-ci-robot ***@***.***> wrote: @bgrant0607 <https://github.com/bgrant0607>: you can't LGTM a PR unless you are assigned as a reviewer. In response to this comment <#38309 (comment)> : /lgtm If you have questions or suggestions related to this bot's behavior, please file an issue against the kubernetes/test-infra <https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:> repository. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#38309 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFVgVL1_mXgnW1nV2RwfBbecAeZol2jUks5rFyO5gaJpZM4LG83C> .

[bgrant0607]

Yes

…

On Dec 7, 2016 1:28 PM, "Tim Hockin" ***@***.***> wrote: should we nix the gh-pages branch now? On Wed, Dec 7, 2016 at 1:23 PM, k8s-ci-robot ***@***.***> wrote: > @bgrant0607 <https://github.com/bgrant0607>: you can't LGTM a PR unless > you are assigned as a reviewer. > > In response to this comment > <https://github.com/kubernetes/kubernetes/pull/ 38309#issuecomment-265577296> > : > > /lgtm > > If you have questions or suggestions related to this bot's behavior, > please file an issue against the kubernetes/test-infra > <https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue :> > repository. > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <https://github.com/kubernetes/kubernetes/pull/ 38309#issuecomment-265577299>, > or mute the thread > <https://github.com/notifications/unsubscribe-auth/AFVgVL1_ mXgnW1nV2RwfBbecAeZol2jUks5rFyO5gaJpZM4LG83C> > . > — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#38309 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHXi0S04H4X-BbNBv649rV4BFi4dgbdwks5rFyTxgaJpZM4LG83C> .

[david-mcmahon]

There are many references to munge-docs.sh:

$ fgrep -r munge-docs.sh *
docs/devel/how-to-doc.md:valid, etc. To munge a document, simply run `hack/update-munge-docs.sh`. We
docs/devel/how-to-doc.md:verify that all documents have been munged using `hack/verify-munge-docs.sh`.
docs/devel/how-to-doc.md:After running `hack/update-munge-docs.sh`, you'll see a table of contents
docs/devel/how-to-doc.md:example file. Then `hack/update-munge-docs.sh` will generate a code block with
docs/devel/how-to-doc.md:generates the following after `hack/update-munge-docs.sh`:
docs/devel/how-to-doc.md:you run `hack/update-munge-docs.sh`. See
docs/devel/how-to-doc.md:After running `hack/update-munge-docs.sh`, you may see some code / mungers in
hack/verify-munge-docs.sh:  echo "${DOCROOT} is out of date. Please run hack/update-munge-docs.sh"
hack/verify-munge-docs.sh:  echo "${EXAMPLEROOT} is out of date. Please run hack/update-munge-docs.sh"
hack/verify-munge-docs.sh:  echo "${KUBE_ROOT}/ is out of date. Please run hack/update-munge-docs.sh"
hack/verify-munge-docs.sh:  echo "Docs need munging. Please run hack/update-munge-docs.sh"
hack/generate-docs.sh:echo "Generated docs have been placed in the repository tree. Running hack/update-munge-docs.sh."
hack/generate-docs.sh:"${KUBE_ROOT}/hack/update-munge-docs.sh"
hack/update-generated-docs.sh:echo "Generated docs have been placed in the repository tree. Running hack/update-munge-docs.sh."
hack/update-generated-docs.sh:"${KUBE_ROOT}/hack/update-munge-docs.sh"
hooks/pre-commit:if ! hack/verify-munge-docs.sh > /dev/null; then
hooks/pre-commit:  echo "  hack/update-munge-docs.sh"

[david-mcmahon]

What's generating TOCs now then? I ask because during the release we update CHANGELOG.md and run munge-docs to update the TOC. If this is the only thing still using the TOC generator, we'll have to come up with something else.

[caesarxuchao]

Are there use cases other than generating TOC for the CHANGELOG.md? If that's the only use case I'd say we can manually run the TOC munger. Otherwise we should keep the update-munge-docs.sh.

[david-mcmahon]

To minimize disruption, let's leave update-munge-doc.sh (and verify?) for now. We'll need an independent TOC generator at some point.

[caesarxuchao]

Ok, I can keep the updaet-. Do we really need the verify-?

[david-mcmahon]

You could probably remove one, but it's a set. Either way.

[caesarxuchao]

Updated. @david-mcmahon PTAL. Thanks.

[thockin]

gh-pages branch has been removed On Wed, Dec 7, 2016 at 1:29 PM, Brian Grant <notifications@github.com> wrote:

…

Yes On Dec 7, 2016 1:28 PM, "Tim Hockin" ***@***.***> wrote: > should we nix the gh-pages branch now? > > On Wed, Dec 7, 2016 at 1:23 PM, k8s-ci-robot ***@***.***> > wrote: > > > @bgrant0607 <https://github.com/bgrant0607>: you can't LGTM a PR unless > > you are assigned as a reviewer. > > > > In response to this comment > > <https://github.com/kubernetes/kubernetes/pull/ > 38309#issuecomment-265577296> > > : > > > > /lgtm > > > > If you have questions or suggestions related to this bot's behavior, > > please file an issue against the kubernetes/test-infra > > <https://github.com/kubernetes/test-infra/issues/ new?title=Prow%20issue > :> > > repository. > > > > — > > You are receiving this because you were mentioned. > > Reply to this email directly, view it on GitHub > > <https://github.com/kubernetes/kubernetes/pull/ > 38309#issuecomment-265577299>, > > or mute the thread > > <https://github.com/notifications/unsubscribe-auth/AFVgVL1_ > mXgnW1nV2RwfBbecAeZol2jUks5rFyO5gaJpZM4LG83C> > > . > > > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <https://github.com/kubernetes/kubernetes/pull/ 38309#issuecomment-265578576>, > or mute the thread > <https://github.com/notifications/unsubscribe-auth/AHXi0S04H4X- BbNBv649rV4BFi4dgbdwks5rFyTxgaJpZM4LG83C> > . > — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#38309 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFVgVN1N3U5BH573WNUWRU-Lt8Ve3RQcks5rFyVFgaJpZM4LG83C> .

[bgrant0607]

@david-mcmahon You use the TOC for CHANGELOG.md?

Pretty much all other docs should be removed.

[bgrant0607]

@thockin Thanks!

[david-mcmahon]

@bgrant0607 Yes. munge-docs is heavy handed for that, but at the time it conveniently took care of the CHANGELOG.md TOC too. Next step is to replace this with a lighter footprint TOC generator and fully remove munge-docs.

[caesarxuchao]

@david-mcmahon may I get the lgtm? Thanks.

[k8s-github-robot]

Automatic merge from submit-queue (batch tested with PRs 37270, 38309, 37568, 34554)

[david-mcmahon]

Now why did I lgtm this? Not sure. But all of these still need to be dealt with (at least for the verify- mentions)

[caesarxuchao]

I'll send a follow-up for this mention:

hooks/pre-commit:if ! hack/verify-munge-docs.sh > /dev/null; then

I'll send a followup to the doc repo to revise the docs.

[nikhiljindal]

Deleting gh-pages branch broke http://kubernetes.io/kubernetes/third_party/swagger-ui/ which is still one of the top results when searching for "kubernetes swagger".
Fixing it in kubernetes/website#1921