Skip to content
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

Add a note not to use -pre releases for production #117

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ The YugabyteDB Aeon Provider can be used to interact with the resources provided
VPC Peerings, Read Replicas and so on. The provider needs to be configured with appropriate credentials before it can base used. The navigation bar on the left
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slight rewording for this, can use in both files:

YugabyteDB is a high-performance, cloud-native, PostgreSQL-compatible distributed SQL database. It is best fit for cloud-native OLTP (real-time, business-critical) applications that need absolute data correctness and at least one of the following: scalability, high tolerance to failures, or globally-distributed deployments. YugabyteDB Aeon is a fully managed YugabyteDB-as-a-Service, providing all the features of YugabyteDB without the operational overhead.

Use the YugabyteDB Aeon Provider to interact with the resources provided by YugabyteDB Aeon, including YugabyteDB clusters, allow lists, VPCs, VPC peerings, read replicas, and more. You must configure the provider with appropriate credentials before using it. Use the left-side navigation to access the resources supported by the provider and related guides.

Note: Don't use -pre releases for production.

hand side provides the details about all the resources supported by the provider and the guides to use the provider.

**Note**: Please don't use the `-pre` releases for production.

## Example Usage

```terraform
Expand Down
4 changes: 3 additions & 1 deletion managed/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ the operational overhead of managing a database.

The YugabyteDB Aeon Provider can be used to interact with the resources provided by YugabyteDB Aeon like the YugabyteDB Clusters, Allow lists, VPCs,
VPC Peerings, Read Replicas and so on. The provider needs to be configured with appropriate credentials before it can base used. The navigation bar on the left
hand side provides the details about all the resources supported by the provider and the guides to use the provider.`,
hand side provides the details about all the resources supported by the provider and the guides to use the provider.

**Note**: Please don't use the ` + "`-pre`" + ` releases for production.`,
Attributes: map[string]tfsdk.Attribute{
"auth_token": {
Description: "The authentication token (API key) of the account this cluster belongs to.",
Expand Down
Loading