Skip to content

Commit 9ba44ee

Browse files
authored
Add FAQs to Documentation (#5193)
* Add FAQs * Add FAQs
1 parent 33b81b4 commit 9ba44ee

File tree

3 files changed

+38
-0
lines changed

3 files changed

+38
-0
lines changed

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- [Identity use cases](./topics/identities-use-cases.md)
1212
- [Multi-tenancy](./topics/multitenancy.md)
1313
- [Workload Identity](./topics/workload-identity.md)
14+
- [FAQs](./topics/FAQ.md)
1415
- [Managed Clusters (AKS)](./managed/managed.md)
1516
- [Adopting Clusters](./managed/adopting-clusters.md)
1617
- [ASO Managed Clusters (AKS)](./managed/asomanagedcluster.md)

docs/book/src/topics/FAQ.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Frequently Asked Questions
2+
3+
## Does CAPZ support Feature X?
4+
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
5+
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
6+
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)
7+
(every Thursday at 9am PT) after each major release.
8+
9+
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
10+
exist yet.
11+
12+
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.
13+
14+
15+
## How can I enable Feature X if it's not?
16+
If CAPZ does not currently support Feature X, you have a couple of options:
17+
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
18+
[Experimental Features](https://cluster-api.sigs.k8s.io/tasks/experimental-features/experimental-features) section in the CAPI documentation for detailed instructions.
19+
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.
20+
21+
## Why doesn't CAPZ support Feature X?
22+
CAPZ prioritizes features based on community demand, relevance to Azure Kubernetes deployments, and resource availability. Thus, Feature X may not be supported because:
23+
- **Limited Demand:** There might be insufficient demand from the community to prioritize its development.
24+
- **Technical Constraints:** Integrating Feature X could present technical challenges that require more time and resources.
25+
- **Roadmap Alignment:** Feature X may not align with our current strategic roadmap or immediate goals.
26+
We continuously evaluate and update our roadmap based on user feedback and evolving requirements, so your input is valuable in shaping future support.
27+
28+
## How do I add Feature X to CAPZ?
29+
To add Feature X to CAPZ, consider following these steps:
30+
1. **Review the Roadmap:** Ensure that Feature X aligns with the CAPZ roadmap and that it's not already planned or in development.
31+
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
32+
feature and its benefits.
33+
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.
34+
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
35+
[mailing lists](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle) to gather support and feedback for Feature X.
36+
By actively participating, you can enhance CAPZ's functionalilty and ensure it meets the needs of the Kubernetes community on Azure.

docs/book/src/topics/topics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ This section contains information which is relevant to managed and self-managed
55
- [Azure Service Operator](./aso.md)
66
- [Clusterclass](./clusterclass.md)
77
- [Identities](./identities.md)
8+
- [FAQ](./FAQ.md)

0 commit comments

Comments
 (0)