This repo contains organizational documents for AKS.
- For new features or user requirements, submit a product requirements document (PRD).
- For designs implementing approved PRDs, submit a design document.
- For changes introducing API changes, submit an api change proposal.
- For process changes or general discussions, create a request for discussion (RFD).
Work in AKS often starts life as user requirements defined by PM in product requirements documents (PRDs).
Developers take accepted product requirements and propose solutions in design documents.
Changes to user-facing APIs require explicit documentation, beyond integration with an accepted design document. This may require iterative back and forth review of API changes and design.
Designs should be accompanied by the associated product requirements document (prd) or request for discussion (rfd).
Dev and PM owners ensure features pass a launch review board (LRB) before gratuating from preview to general availability (GA).
graph LR
A[PRD] --> B
B[API Review] -.-> C
C -.-> B
C[Design Doc] --> H
H[Code] --> D
D[Preview] --> E
E[LRB] --> F[GA]
Description of how to install and use the code or content goes here
There are no prerequisites required to run this code or use this repository.
This repository does not hold installable content.
At this time, the repository does not use continuous integration or produce a website, artifact, or anything deployed.
Access to this repo is controlled via AAD mirrored to GitHub groups. See [https://github.com/azure-management-and-platforms/aks-handbook/blob/main/.github/acl/access.yml] for the groups that have access to the repo.
Access levels generally mean:
Read: Can fork the repo and send PRs.Write: Can push directly to branches in the repo (not main, it's protected).
Make sure you're attempting to clone/push with your enterprise GitHub credentials.
- If you're using a PAT, make sure it's set to "all repositories".
- If you're using GCM it should just work.
This repository prefers outside contributors start forks rather than branches. For pull requests more complicated than typos, it is often best to submit an issue first.
If you are a new potential collaborator who finds reaching out or contributing to another project awkward, you may find it useful to read these tips & tricks on InnerSource Communication.
This code was not created with a strong expectation that others outside the immediate creators would reuse or contribute to it. If you do reuse it, please let us know via an email to the person noted in the CODEOWNERS file, so we can best understand the value of this repository.
If you have trouble doing something related to this repository, please keep in mind that the following actions require using GitHub inside Microsoft (GiM) tooling and not the normal GitHub visible user interface!
- Creating a repository
- Changing repository visibility
- Gaining repository permissions, access, and roles
- Enabling easy access to your low sensitivity and widely applicable repository by setting it to Internal Visibility and having any FTE who wants to see it join the 1ES Enterprise Visibility MyAccess Group
- Migrating repositories
- Setting branch protection
- Setting up GitHubActions
- and other actions
This README started as a template provided as part of the StartRight tool that is used to create new repositories safely. Feedback on the README template used in this repository is requested as an issue.