docs: add disclaimer about preview APIs and items#239
Open
HasanAboShally wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a disclaimer to the docs landing page to clarify that, while the Fabric CLI is GA, it may interact with Fabric preview items and preview public APIs that are not covered under the standard Fabric SLA.
Changes:
- Add a new “Release status” section on the docs landing page with a preview-API/items disclaimer.
- Add an unreleased changelog entry documenting the docs update.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/index.md | Adds GA/preview disclaimer and links to release notes and Fabric API preview docs. |
| .changes/unreleased/docs-preview-disclaimer.yaml | Records the docs change in the changelog system. |
Comment on lines
+30
to
+34
| ## Release status | ||
|
|
||
| The Fabric CLI is generally available (GA). For the current version and changelog, see the [release notes](./release-notes.md). Run `fab --version` to check your installed version. | ||
|
|
||
| **Note:** The CLI may support Fabric items that are still in preview, and some commands may rely on Fabric public APIs that are still in [preview](https://learn.microsoft.com/rest/api/fabric/articles/api-structure#api-endpoints). Preview items and APIs aren't covered by the standard Fabric SLA. |
|
|
||
| The Fabric CLI is generally available (GA). For the current version and changelog, see the [release notes](./release-notes.md). Run `fab --version` to check your installed version. | ||
|
|
||
| **Note:** The CLI may support Fabric items that are still in preview, and some commands may rely on Fabric public APIs that are still in [preview](https://learn.microsoft.com/rest/api/fabric/articles/api-structure#api-endpoints). Preview items and APIs aren't covered by the standard Fabric SLA. |
Comment on lines
+30
to
+34
| ## Release status | ||
|
|
||
| The Fabric CLI is generally available (GA). For the current version and changelog, see the [release notes](./release-notes.md). Run `fab --version` to check your installed version. | ||
|
|
||
| **Note:** The CLI may support Fabric items that are still in preview, and some commands may rely on Fabric public APIs that are still in [preview](https://learn.microsoft.com/rest/api/fabric/articles/api-structure#api-endpoints). Preview items and APIs aren't covered by the [Microsoft Fabric SLA](https://www.microsoft.com/licensing/docs/view/Service-Level-Agreements-SLA-for-Online-Services). |
| @@ -0,0 +1,4 @@ | |||
| kind: docs | |||
| body: Add a Release status section to the docs landing page indicating GA status, pointing to the release notes for the current version, and noting that the CLI may support Fabric items and rely on Fabric public APIs that are still in preview (and therefore not covered by the standard Fabric SLA) | |||
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds a Release status section to the docs landing page. The section states that the Fabric CLI is generally available (GA), points to the release notes for the current version and changelog, mentions
fab --versionto check the installed version, and ends with a short note: the CLI may support Fabric items that are still in preview, and some commands may rely on Fabric public APIs that are still in preview — and those preview items and APIs aren't covered by the Microsoft Fabric SLA.Changes
docs/index.md: add a new## Release statussection between What you can do and Get started. Uses plain prose with a bolded**Note:**(no admonition extension is enabled inmkdocs.yml, so admonitions render as raw!!!text)..changes/unreleased/docs-preview-disclaimer.yaml: changie entry (kind: docs).