docs: expand availability tags from 6 to 17 values #4324
+35
−4
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| tags: ["navigation", "configuration", "docs.yml"] | ||
| --- | ||
|
|
||
| ## Expanded availability tags | ||
|
|
||
| You can now use 17 availability tags for pages, sections, folders, and API reference endpoints. In addition to the original 6 values (`stable`, `generally-available`, `in-development`, `pre-release`, `deprecated`, `beta`), the following are now supported: | ||
|
Contributor
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment. 📝 [vale] reported by reviewdog 🐶
Contributor
There was a problem hiding this comment.
|
||
|
|
||
| - `release-candidate` | ||
| - `public-beta` | ||
| - `private-beta` | ||
| - `limited-availability` | ||
| - `canary-release` | ||
| - `preview` | ||
| - `alpha` | ||
| - `experimental` | ||
| - `internal` | ||
| - `sunset` | ||
| - `retired` | ||
|
|
||
| ```yaml docs.yml {3, 7} | ||
| navigation: | ||
| - section: Plant API | ||
| availability: generally-available | ||
| contents: | ||
| - page: Getting started | ||
| path: ./pages/getting-started.mdx | ||
| availability: preview | ||
| ``` | ||
|
|
||
| <Button intent="none" outlined rightIcon="arrow-right" href="/learn/docs/configuration/navigation#availability">Read the docs</Button> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| You can set the availability for the entire API reference or for specific sections in your `docs.yml` configuration. Options are: `stable`, `generally-available`, `release-candidate`, `public-beta`, `beta`, `private-beta`, `limited-availability`, `canary-release`, `preview`, `pre-release`, `alpha`, `experimental`, `internal`, `in-development`, `sunset`, `deprecated`, or `retired`. | ||
|
Contributor
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
|
|
||
| When you set the availability of a section, all of the endpoints in that section are automatically marked with that availability unless explicitly set otherwise. | ||
|
|
||
|
|
@@ -12,4 +12,4 @@ navigation: | |
| icon: flower | ||
| contents: | ||
| # endpoints here | ||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated