Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move mungedocs #29314

Closed
artasparks opened this issue Jul 20, 2016 · 7 comments
Closed

Move mungedocs #29314

artasparks opened this issue Jul 20, 2016 · 7 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience.

Comments

@artasparks
Copy link
Contributor

Now that the docs are in kubernetes.github.io, I think it makes sense to move the mungedocs program and fix it up: (found here: https://github.com/kubernetes/kubernetes/tree/master/cmd/mungedocs)

Thoughts about where it should go?

  • New repo (kubernetes/mungedocs)
  • Into kubernetes.github.io directly
  • Into kubernetes/contrib. This is my least favorite of the options since contrib is currently a general purpose dumping ground.
@apelisse apelisse added kind/documentation Categorizes issue or PR as related to documentation. team/ux labels Jul 20, 2016
@bgrant0607 bgrant0607 added sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Jul 20, 2016
@bgrant0607
Copy link
Member

bgrant0607 commented Jul 20, 2016

@Kashomon

Yes, both kubernetes and contrib repos are dumping grounds.

I was thinking we should create a "github-tools" repo for mungedocs, mungegithub, etc.

The process @philips proposed on kubernetes-dev suggested emailing the proposal to kubernetes-dev.

cc @kubernetes/docs @kubernetes/contributor-experience

@bgrant0607
Copy link
Member

Note that the docs in kubernetes.github.io have different formatting rules/needs than docs in other repos. The reason is that the kubernetes.github.io docs are converted to html and rendered with CSS+JS, whereas the other docs are viewed directly as markdown. One example is TOC generation, which is done dynamically for kubernetes.io and statically for markdown. Link-checking rules are different, too.

I think the previous attempt by @pwittrock was in kubernetes-retired/contrib#590

@spiffxp
Copy link
Member

spiffxp commented Jul 17, 2017

@david-mcmahon is cmd/mungedocs even used anymore? I looked through community, contrib, kubernetes, kubernetes.github.io, release, and test-infra and couldn't find an actual call.

ref: #38309

I think it's been replaced by https://github.com/kubernetes/md-check

@spiffxp
Copy link
Member

spiffxp commented Jul 17, 2017

I take that back, pinged on #sig-release in slack, apparently it's still used via travis for kubernetes.github.io

https://github.com/kubernetes/kubernetes.github.io/blob/2f82ff8a96bcf009fed4507100a1ade55de7fdc5/.travis.yml#L29

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

Prevent issues from auto-closing with an /lifecycle frozen comment.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or @fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 1, 2018
@spiffxp
Copy link
Member

spiffxp commented Jan 7, 2018

/close
This was done
kubernetes/website#5178 - moved it to kubernetes/website
kubernetes/website#5191 - removed it from kubernetes/website

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience.
Projects
None yet
Development

No branches or pull requests

6 participants