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

Book has documentation for features not yet released #2786

Closed
mjnovice opened this issue Nov 7, 2022 · 11 comments
Closed

Book has documentation for features not yet released #2786

mjnovice opened this issue Nov 7, 2022 · 11 comments
Labels
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.

Comments

@mjnovice
Copy link
Contributor

mjnovice commented Nov 7, 2022

According to the document, we can specify vnets in a separate resourceGroup but that doesn't seem to be the case.

image

@CecileRobertMichon
Copy link
Contributor

The book is currently published from the main branch. This feature is available in the main branch but not yet in the latest release (release ETA is this week https://github.com/kubernetes-sigs/cluster-api-provider-azure/milestone/28).

@mjnovice
Copy link
Contributor Author

mjnovice commented Nov 7, 2022

@CecileRobertMichon thanks for the clarity, however I see that in the same doc we are referring to
image
1.2.4, is that just by chance ?

@CecileRobertMichon
Copy link
Contributor

@mjnovice not sure I agree that those two things are in the same doc: one screenshot seems to be coming from https://capz.sigs.k8s.io/ while the other is part of https://cluster-api.sigs.k8s.io/user/quick-start.html, those are two different Netlify websites with each their own publishing pipeline

Since the book is meant to be user-facing, it makes sense to change the default to point to the latest release docs.

@mjnovice
Copy link
Contributor Author

mjnovice commented Nov 7, 2022

Sure, thanks @CecileRobertMichon again for the clarification.

@CecileRobertMichon
Copy link
Contributor

/retitle Book has documentation for features not yet released

@k8s-ci-robot k8s-ci-robot changed the title [Documentation]: BYO VNet for AzureManagedCluster is incorrect in the public docs Book has documentation for features not yet released Nov 7, 2022
@CecileRobertMichon
Copy link
Contributor

Previous discussion on the topic for CAPI: kubernetes-sigs/cluster-api#6017

@CecileRobertMichon
Copy link
Contributor

@mjnovice not sure if you're on slack, couldn't find your username, but here's the thread about this: https://kubernetes.slack.com/archives/CEX9HENG7/p1667858516778029

Would love to hear your thoughts as a user who experienced this confusion

@mjnovice
Copy link
Contributor Author

mjnovice commented Nov 9, 2022

@CecileRobertMichon added my thoughts on the thread.

@k8s-triage-robot
Copy link

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

This bot triages issues and PRs 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 or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR 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 Feb 7, 2023
@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 Mar 9, 2023
@dtzar
Copy link
Contributor

dtzar commented Apr 5, 2023

We now have the process to only update the book website for what is current for the last shipped version of CAPZ. The documentation in the main repo itself contains docs for whatever is current in the code repo which gets published at minor release.

It would be nice to have a versioned website, but this is quite a bit of work and out of scope for this issue.

Closing since this is technically resolved now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Projects
Archived in project
Development

No branches or pull requests

5 participants