Skip to content

Make documentation Cosmos-version aware #750

Open
@tatiana

Description

Context

As of December 2023, we are hosting Cosmos docs as a Github page, built out of Cosmos main branch.

The consequence is that the documentation, many times, is ahead of the features available in the latest stable releases. Additionally, users need help seeing the documentation relative to a specific version of Cosmos.

Some tools support documentation based on the source code version, such as ReadTheDocs:
https://readthedocs.com/

Since Airflow and other Astronomer projects use this tool, it should be straightforward to adopt it.

Acceptance criteria

  • Users can see what the Cosmos version associated with a specific documentation page
  • Users can check the documentation for a specific version of Cosmos

Metadata

Assignees

No one assigned

    Labels

    area:docsRelating to documentation, changes, fixes, improvementdbt:docsPrimarily related to dbt docs command or functionalitydo-not-staleRelated to stale job and dosubotpriority:mediumMedium priority issues are important issues that may have a workaround and medium impact

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions