-
Notifications
You must be signed in to change notification settings - Fork 68
Add detailed versioning docs for single preview #3813
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
Conversation
|
No changes needing a change description found. |
|
You can try these changes here
|
ea65c7e to
b1f95a6
Compare
website/src/content/docs/docs/howtos/Versioning/ARM/03-stable-after-preview.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/07-perpetual-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/02-preview-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/uncommon-scenarios/02-perpetual-preview.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/uncommon-scenarios/02-perpetual-preview.md
Show resolved
Hide resolved
b1f95a6 to
d31195d
Compare
haolingdong-msft
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @markcowl for putting the versioning related documents together in this PR. It is really helpful and I've learnt a lot! left some comments for understanding and clarification purpose. Thank you so much for your guidance!
May I also ask two general questions?
- I saw there is also a versioning doc here: https://azure.github.io/typespec-azure/docs/howtos/versioning/preview-version/. Is this for data-plane? (Basically two versioning related documents in the typespec azure website, so I'm just a bit confused)
2. Does this PR include information in below two docs about versioning you've shared before? From my understanding, it includes, but just would like to confirm.
Rules for Versioning Decorators.loop
Scenarios for API Evolution.loop
website/src/content/docs/docs/howtos/ARM/versioning/02-preview-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/02-preview-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/02-preview-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/04-preview-after-stable.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/03-stable-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/03-stable-after-preview.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/03-stable-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/uncommon-scenarios/01-converting-specs.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/07-perpetual-preview.md
Outdated
Show resolved
Hide resolved
Yeah, one really important thing is that we make this documentation visible for those who need to see it. I think we might rename the existing doc to 'indicate that it is for 'data-plane only' and introduce another doc alongside it that is for arm, with links to the rest of this documentation. |
website/src/content/docs/docs/howtos/Versioning/ARM/02-preview-after-preview.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/02-preview-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/02-preview-after-preview.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/03-stable-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/03-stable-after-preview.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/06-converting-specs.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/uncommon-scenarios/02-perpetual-preview.md
Show resolved
Hide resolved
d43e78c to
b33bd7b
Compare
qiaozha
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Haven't read all of them yet.
website/src/content/docs/docs/howtos/Versioning/ARM/01-about-versioning.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/01-about-versioning.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/02-preview-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/ARM/versioning/02-preview-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/02-preview-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/02-preview-after-preview.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/03-stable-after-preview.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/03-stable-after-preview.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/03-stable-after-preview.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/04-preview-after-stable.md
Show resolved
Hide resolved
qiaozha
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To summarize the main different opinion, I have here is:
- we can have a vlatestPreview enum key for latest preview versions in the Versions enum.
- we can change the mechanism of version continuity of all versioning decorators for preview versions to not extend to stable. It can be extended to newer preview but that was because we have move forward the vlatestPreview value in the version enum. But we can keep the version continuity of all versioning decorators for stable versions.
So that if any feature/changes are still in preview, it has to have the according versioning decorators with a vlatestPreview enum member in it. TypeSpec authors can just focus on the changes happened after it gets GA.
website/src/content/docs/docs/howtos/Versioning/ARM/uncommon-scenarios/01-converting-specs.md
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Versioning/ARM/uncommon-scenarios/02-perpetual-preview.md
Show resolved
Hide resolved
9101125 to
8e3b398
Compare
5046db1 to
469075e
Compare

No description provided.