Improvements to API version and breaking change docs
- Dominant language
- C#
- Stars
- 135
- Forks
- 260
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 144
Description
- Cross-link breaking changes doc and [API guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning). See email thread `RE: On consolidating API versioning guidance docs | RE: Redis Enterprise 2024-06-01-preview - Breaking change(cross-verion) review `
- Update aka.ms/azsdk/autorest to link to uniform versioning article in specs repo
- Cross link between aka.ms/azsdk/spec-dirs and [API guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning)
- Mention sequential API versions in where appropriate and dedup these articles:
- https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-versioning
- https://eng.ms/docs/products/azure-developer-experience/design/api-specs-pr/api-versions-and-branches
- uniform versioning in specs repo
- https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning
- Do the fixes from `Re: To encourage and guide service partners to remove their API specs from the public spec repo when their services or service API versions are deprecated` (I might have done all or some of them already)
- Update docs for `VersioningReviewRequired` per `Re: Question about the process to follow when there is a versioning issue`
Contributor guide
Assessment
This issue has not been assessed yet.