docs
docs copied to clipboard
Add clarification to `-ci/cd enforce` reference + improve search behavior
Issue Type
Inaccurate, misleading, or out-of-date information
Links to Affected Docs
- https://docs.astronomer.io/astro/deployment-details#enforce-cicd-deploys
- https://docs.astronomer.io/astro/set-up-ci-cd
- https://docs.astronomer.io/astro/api-keys
- https://docs.astronomer.io/astro/deployment-api-tokens
- https://docs.astronomer.io/astro/organization-api-tokens
- https://docs.astronomer.io/astro/workspace-api-tokens
The Issue or Context
If a user attempts to deploy DAGs to a deployment with enforce CI/CD enabled, they receive a CLI error message that mentions API tokens and API Keys. However, the first results when searching for API Tokens or Keys shares pages for the deprecated API Keys features.
Fix or Proposed Change
- Clarify this behavior in the CI/CD deployment behavior docs
- De-emphasize the deprecated API key docs in search results
- Clarify what an API token is and why it is used in relevant API Token docs
Additional Notes
- API Key deprecation docs notes
- https://github.com/astronomer/astro-cli/pull/1580
Required Reviewers
No response