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

Examine Minikube pages for dual-hosted content and content that should move to minikube docs site #15969

Closed
aimeeu opened this issue Aug 20, 2019 · 21 comments · Fixed by #24533
Closed
Assignees
Labels
sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@aimeeu
Copy link
Contributor

aimeeu commented Aug 20, 2019

This is a Feature Request

What would you like to be added
Examine minikube pages to determine what should be hosted by minikube docs and what should be hosted by k8s docs.

Following the discussion on dual-hosted content (#15576), I think guides for installing minikube should be in the minikube project's docs, and then the k8s docs link to those installation guides. State that the prerequisite for the Installing Kubernetes with Minikube page is successful installation of minikube and point to minkube docs.
Already the k8s docs are stale with regard to container runtimes that minikube supports.

k8s-specific how-to pages should remain in k8s docs.

Candidates to be removed from k8s docs and/or moved to minikube docs:

Why is this needed
Dual-hosted content places undo burden on maintainers to ensure content is up-to-date in both places.

With all minikube installation configuration instructions on the minikube site, hopefully all minikube environment errors will be directed to the minikube team.

Comments
Relates to #15576 Clarify style guide: eliminate third-party content
Relates to #15748 Umbrella Issue: Remove Third-Party Content
Also see closed issue #6339 Restructure and Rewrite Minikube docs

@aimeeu aimeeu changed the title Minikube Examine Minikube pages for dual-hosted content and content that should move to minikube docs site Aug 20, 2019
@RA489
Copy link

RA489 commented Aug 21, 2019

/assign @RA489

@sftim
Copy link
Contributor

sftim commented Aug 21, 2019

/sig cluster-lifecycle

@k8s-ci-robot k8s-ci-robot added the sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. label Aug 21, 2019
@sftim
Copy link
Contributor

sftim commented Aug 21, 2019

Will this work eventually mean filing docs issues against the Minikube repo?

@aimeeu
Copy link
Contributor Author

aimeeu commented Aug 21, 2019

It may - really depends on what @RA489 finds. In my quick review yesterday, I found duplicate content that was outdated in kubernetes/website when compared to the minikube website and docs. minikube has its own contributing to docs page!

@RA489
Copy link

RA489 commented Aug 27, 2019

I think as most of the doc has been to moved to minikube site we can remove the duplicate content.
@tstromberg wdyt?

@tstromberg
Copy link
Contributor

tstromberg commented Aug 27, 2019

YES!

@zacharysarah and I discussed this briefly when the new minikube docs site launched (two weeks ago), and I'm now convinced that we should replace the duplicate content from kubernetes/website with pointers to the minikube docs site. Make it so!

It slightly outside of the scope of this issue - but I am also open to moving additional minikube-related content from kubernetes/website to the minikube site. There are glaring omissions on both sides. That said, it may make sense for 'Hello Minikube', for example, to continue to exist on the Kubernetes website.

@aimeeu
Copy link
Contributor Author

aimeeu commented Aug 27, 2019

@tstromberg - thanks for your feedback! I agree that the Hello Minikube tutorial can stay since it is primarily about using Kubernetes. So probably the only content in Hello Minikube that needs to be updated are the Minikube links at the top of the page.
@RA489 thanks for working on this!

@tstromberg
Copy link
Contributor

@RA489 - thanks for working on this. Anything I can help out with?

@dims
Copy link
Member

dims commented Sep 13, 2019

/hold

please see the hold on the umbrella issue

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 13, 2019
@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.

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 Dec 12, 2019
@tstromberg
Copy link
Contributor

Are we able to move on this issue yet? I'd really like to begin dismantling the duplicate and outdated reference information on the Kubernetes website related to minikube - though keep the great "Hello Minikube" tutorial that isn't duplicated elsewhere.

@zacharysarah
Copy link
Contributor

@dims 👋 Given that this issue is reasonably isolated from larger policy questions (i.e., this issue involves re-homing content specific to Minikube with the consent of its contributors), are you OK with lifting the hold?

@dims
Copy link
Member

dims commented Jan 10, 2020

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 10, 2020
@zacharysarah
Copy link
Contributor

@dims Thanks! 🙏

@tstromberg Go for it!

@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

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 rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 9, 2020
@zacharysarah
Copy link
Contributor

/remove-lifecycle rotten

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Feb 10, 2020
@tstromberg
Copy link
Contributor

/assign

@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.

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 Jul 30, 2020
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

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 rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Aug 30, 2020
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

@sftim
Copy link
Contributor

sftim commented Oct 12, 2020

/remove-lifecycle rotten
/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Oct 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
8 participants