Skip to content

Review and Improve Current Documentation for Helm Chart #14303

@kaxil

Description

@kaxil

Comments from #10752 (comment):

  • the values.yaml file is missing comments for most values
  • more general explanations are pretty sparse (it seems we currently only have short paragraphs in the README)
  • examples of common environments are missing (GKE, EKS, On-Prem)
  • provide upgrade guides for major/minor version bumps of the chart

All of this should be initially included in README.md and ideally we should have some sort of documentation for Helm Chart here: https://airflow.apache.org/docs/ (maybe https://airflow.apache.org/docs/helm-chart/stable)

We can also autogenerate some docs based on values.schema.json as mentioned in #11077

Metadata

Metadata

Assignees

Labels

area:helm-chartAirflow Helm Chartkind:taskA task that needs to be completed as part of a larger issuetelemetryTelemetry-related issues

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions