From 9ba44ee10e424c09c9e642632090ec2f94a448ce Mon Sep 17 00:00:00 2001 From: "Morgan B." <134453287+mbrow137@users.noreply.github.com> Date: Tue, 22 Oct 2024 18:16:52 -0400 Subject: [PATCH] Add FAQs to Documentation (#5193) * Add FAQs * Add FAQs --- docs/book/src/SUMMARY.md | 1 + docs/book/src/topics/FAQ.md | 36 ++++++++++++++++++++++++++++++++++ docs/book/src/topics/topics.md | 1 + 3 files changed, 38 insertions(+) create mode 100644 docs/book/src/topics/FAQ.md diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index cea635b41df..324e54b4af7 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -11,6 +11,7 @@ - [Identity use cases](./topics/identities-use-cases.md) - [Multi-tenancy](./topics/multitenancy.md) - [Workload Identity](./topics/workload-identity.md) + - [FAQs](./topics/FAQ.md) - [Managed Clusters (AKS)](./managed/managed.md) - [Adopting Clusters](./managed/adopting-clusters.md) - [ASO Managed Clusters (AKS)](./managed/asomanagedcluster.md) diff --git a/docs/book/src/topics/FAQ.md b/docs/book/src/topics/FAQ.md new file mode 100644 index 00000000000..41825eb22a3 --- /dev/null +++ b/docs/book/src/topics/FAQ.md @@ -0,0 +1,36 @@ +# Frequently Asked Questions + +## Does CAPZ support Feature X? +The best way to check if CAPZ supports a feature is by reviewing [the roadmap](https://capz.sigs.k8s.io/roadmap) and [the public milestones](https://github.com/kubernetes-sigs/cluster-api-provider-azure/milestones). The public milestones will +also provide insight into what's coming in the next 1-2 months. All open items for the next milestone are displayed in the [Milestone-Open project board](https://github.com/orgs/kubernetes-sigs/projects/26/views/7), which is updated at the +start of each 2-month release cycle. Planning and discussions for these milestones typically happen during the [Cluster API Azure Office Hours](https://docs.google.com/document/d/1P2FrRjuCZjGy0Yh72lwWCwmXekSEkqliUVTmJy_ETIk/edit?tab=t.0) +(every Thursday at 9am PT) after each major release. + +For managed (AKS) clusters, all features should be available when using the AzureASOManaged API specification, which provides 100% API surface coverage via ASO. If there is no issue for a new feature in the repository, it likely does not +exist yet. + +You can also check the [GitHub repository](https://github.com/kubernetes-sigs/cluster-api-provider-azure) issues and milestones for more details on specific features. + + +## How can I enable Feature X if it's not? +If CAPZ does not currently support Feature X, you have a couple of options: +1. **Check for Experimental Features**: Sometimes features not fully supported are available as experimental. You can experiment with said features by enabling them using feature gates. Refer to the +[Experimental Features](https://cluster-api.sigs.k8s.io/tasks/experimental-features/experimental-features) section in the CAPI documentation for detailed instructions. +2. **Contribute to CAPZ**: If you're eager to use Feature X, consider contributing to the CAPZ project. Our community welcomes contributions, and your input can help accelerate support for new features. + +## Why doesn't CAPZ support Feature X? +CAPZ prioritizes features based on community demand, relevance to Azure Kubernetes deployments, and resource availability. Thus, Feature X may not be supported because: +- **Limited Demand:** There might be insufficient demand from the community to prioritize its development. +- **Technical Constraints:** Integrating Feature X could present technical challenges that require more time and resources. +- **Roadmap Alignment:** Feature X may not align with our current strategic roadmap or immediate goals. +We continuously evaluate and update our roadmap based on user feedback and evolving requirements, so your input is valuable in shaping future support. + +## How do I add Feature X to CAPZ? +To add Feature X to CAPZ, consider following these steps: +1. **Review the Roadmap:** Ensure that Feature X aligns with the CAPZ roadmap and that it's not already planned or in development. +2. **Submit an Issue:** Open an issue on our [GitHub Repository](https://github.com/kubernetes-sigs/cluster-api-provider-azure/issues) to discuss Feature X with the maintainers and the community. Please provide detailed information about the +feature and its benefits. +3. **Contribute Code:** If you have the capabilities, you can implement Feature X yourself. Fork the repository, develop the feature following our contribution guidelines, and submit a pull request for review. +4. **Collaborate with the Community:** Engage with and receive updates from other contributors and maintainers through our [Slack channel](https://kubernetes.slack.com/messages/CEX9HENG7) or +[mailing lists](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle) to gather support and feedback for Feature X. +By actively participating, you can enhance CAPZ's functionalilty and ensure it meets the needs of the Kubernetes community on Azure. diff --git a/docs/book/src/topics/topics.md b/docs/book/src/topics/topics.md index 0736669df8d..2e25eda2655 100644 --- a/docs/book/src/topics/topics.md +++ b/docs/book/src/topics/topics.md @@ -5,3 +5,4 @@ This section contains information which is relevant to managed and self-managed - [Azure Service Operator](./aso.md) - [Clusterclass](./clusterclass.md) - [Identities](./identities.md) +- [FAQ](./FAQ.md)