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

documentation for start command is from the future #18543

Closed
FlorinAndrei opened this issue Mar 29, 2024 · 12 comments
Closed

documentation for start command is from the future #18543

FlorinAndrei opened this issue Mar 29, 2024 · 12 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.

Comments

@FlorinAndrei
Copy link

This page:

https://minikube.sigs.k8s.io/docs/commands/start/

Claims this option is available for the start command:

--ha Create Highly Available Multi-Control Plane Cluster with a minimum of three control-plane nodes that will also be marked for work.

That is not true for the current stable version of minikube (1.32.0). It only appears to be true for the current beta (???).

Please reconcile.

@T-Lakshmi
Copy link

Hi @FlorinAndrei,

That is not true for the current stable version of minikube (1.32.0). It only appears to be true for the current beta (???).

Yes, you are true. This feature is newly implemented in current beta version of minikube release.

@T-Lakshmi
Copy link

--ha Create Highly Available Multi-Control Plane Cluster with a minimum of three control-plane nodes that will also be marked for work.

As minikube documentation includes information about both current stable and beta release types, i think it is recommended that we leave this information as is and add a small note (it is currently available for v1.33.0-beta.0 release).

what do you think @FlorinAndrei ?

@FlorinAndrei
Copy link
Author

All other projects I've seen in my years in the industry make sure their main official documentation is for the stable version.

When they do provide documentation for the beta version, it's a separate version of the documentation, and it is very clearly marked as such, and it does not mislead the users into thinking it's the stable branch documentation.

I have no clue why minikube does things differently from the rest of the world.

If you want your users to use the beta code more quickly, then promote it to stable.

@afbjorklund
Copy link
Collaborator

It is a bug, the website is carried in the main monorepo and so it is updated whenever git HEAD is...

There is no special promoting of beta releases.

Preferrably it should default to "Latest" release.

@afbjorklund afbjorklund added the kind/documentation Categorizes issue or PR as related to documentation. label Apr 2, 2024
@T-Lakshmi
Copy link

/kind bug

@k8s-ci-robot k8s-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label Apr 4, 2024
@afbjorklund
Copy link
Collaborator

Last time it was deemed to have too much work to have one documentation site per minikube version:

But it could be possible to have two sites, one for main branch and for the latest release version.

Note that minikube does not have release branches

@FlorinAndrei
Copy link
Author

But it could be possible to have two sites, one for main branch and for the latest release version.

If it does not imply that features currently only in beta are also in the latest stable release, then it should be fine. That's all I'm asking. It's the leakage from beta into stable that is not right.

@afbjorklund
Copy link
Collaborator

It's the leakage from beta into stable that is not right.

It's not only beta, it is everything that is in the repository.

But I was meaning something like this (for another project):

https://apptainer.org/documentation/

The latest release is labelled latest below. The current development version will be labelled main .

The lack of a stable branch complicates the git, but there is json:

https://github.com/kubernetes/minikube/blob/master/deploy/minikube/releases-v2.json (v1.32.0)

However, I don't even know where the netlify job is configured...

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/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 3, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle rotten
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/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 2, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

@k8s-ci-robot
Copy link
Contributor

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Projects
None yet
Development

No branches or pull requests

5 participants