From 977421cc5a1728be2397ffc119a9b134f513d50b Mon Sep 17 00:00:00 2001 From: luisquix <120378585+luisquix@users.noreply.github.com> Date: Thu, 5 Sep 2024 11:17:11 +0200 Subject: [PATCH] Remove beta warning (#66) * Remove beta warning * small cosmetic fixes --- docs/cli-local-secrets.md | 2 +- docs/overview.md | 6 ------ docs/yaml-reference/app-descriptor.md | 4 ++-- 3 files changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/cli-local-secrets.md b/docs/cli-local-secrets.md index f58c43d..ae0b9ac 100644 --- a/docs/cli-local-secrets.md +++ b/docs/cli-local-secrets.md @@ -47,7 +47,7 @@ Adding the `api_secret_token` under the "Secrets" section ensures it is handled To integrate the new secret into your pipeline, run the following command: ```bash -$ quix pipeline update +quix pipeline update ``` This command updates your pipeline configuration, incorporating the secret into the `quix.yaml` file and generating or updating the `.secrets` file: diff --git a/docs/overview.md b/docs/overview.md index 25258d6..3d7004b 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -22,12 +22,6 @@ Using the **cloud commands**, you can manage your Quix Cloud account from the co With the **utility commands**, you can perform tasks such as checking your status, updating the CLI, changing the CLI configuration, using interactive help, and managing contexts (the endpoint or environment the CLI is connected to). -## Development status - -!!! warning "Quix CLI is in development" - - Quix CLI is currently Beta, and is under development. This documentation may not be completely up to date, as the CLI is updated frequently, with new commands added, some commands removed, and changes to command syntax. Please use the Quix CLI built-in help for the very latest information. - ## GitHub repository View additional information about the CLI in the [GitHub repository](https://github.com/quixio/quix-cli){target=_blank}. diff --git a/docs/yaml-reference/app-descriptor.md b/docs/yaml-reference/app-descriptor.md index a252807..34f7437 100644 --- a/docs/yaml-reference/app-descriptor.md +++ b/docs/yaml-reference/app-descriptor.md @@ -94,9 +94,9 @@ Changes to the `app.yaml` file should be made thoughtfully, as they can affect a ## Best Practices - **Consistent Naming:** Ensure that variable names are clear and descriptive to avoid confusion during deployment. -- + - **Security:** Handle `Secret` type variables with care to ensure sensitive information is not exposed. -- + - **Documentation:** Keep the `description` field updated to accurately reflect the purpose and usage of each variable. By managing your `app.yaml` file effectively, you can ensure that your application is deployed consistently and operates reliably in various environments, while retaining the flexibility to adapt or remove elements as needed.