-
Notifications
You must be signed in to change notification settings - Fork 532
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
fix(docs): Map @alpha
tags to "Legacy" alerts in API documentation
#21525
Conversation
…notice-customization
Pending #21524 being merged and published. At which time the dependency can be updated in this PR, and the new needed functionality can be leveraged. |
…omization' of https://github.com/Josmithr/FluidFramework into api-markdown-documenter/support-release-tag-notice-customization
…omization' into docs/legacy-alerts
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.
Looks good as far as I can tell. Small nit below.
tools/api-markdown-documenter/src/utilities/ApiItemUtilities.ts
Outdated
Show resolved
Hide resolved
The link checker appears to be broken. We must not be building the API docs before running it. I'll investigate separately. |
🔗 Found some broken links! 💔 Run a link check locally to find them. See linkcheck output
|
In our repo, we are currently using the
@alpha
release tag to mean something different than "alpha". We currently map it to a concept we're calling "legacy". This PR updates the generated API docs to use "Legacy" terminology in various tables in the API docs, instead of "Alpha" to avoid any customer confusion.In the future, we plan on reclaiming
@alpha
for its traditional meaning, and using a@legacy
tag for the special concept. The configurations changed here will be need to changed again at that time.Before
After
AB#8406