Skip to content

Change API Documenter (BETA) annotation to (Public Preview) #8789

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

Merged
merged 3 commits into from
Feb 13, 2025

Conversation

dlarocque
Copy link
Contributor

The API documenter annotates @beta APIs with (BETA) in the docs. We use @beta to show that an API is in public preview, so we should update the annotation to be (Public Preview).

This affects two Firestore features; MultiDB (@tom-andersen #7356) and Indexes (@wu-hui #6510) - are these two APIs meant for public preview?

Example of (BETA) annotation in the docs:
image

Copy link

changeset-bot bot commented Feb 12, 2025

⚠️ No Changeset found

Latest commit: 4b29dd2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@dlarocque dlarocque mentioned this pull request Feb 12, 2025
@google-oss-bot
Copy link
Contributor

google-oss-bot commented Feb 12, 2025

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Feb 12, 2025

@dlarocque dlarocque marked this pull request as ready for review February 12, 2025 20:27
@dlarocque dlarocque requested review from a team as code owners February 12, 2025 20:27
@dlarocque dlarocque merged commit b92592d into main Feb 13, 2025
37 of 38 checks passed
@dlarocque dlarocque deleted the dl/api-documenter-beta branch February 13, 2025 18:46
@firebase firebase locked and limited conversation to collaborators Mar 16, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants