Skip to content

README.adoc

Latest commit

 

History

History
62 lines (54 loc) · 1.66 KB

README.adoc

File metadata and controls

62 lines (54 loc) · 1.66 KB
Raw

DataStax Astra CLI docs

This repository contains the AsciiDoc source files for the DataStax Astra CLI documentation.

To learn how to update the documentation, see the Docs team Confluence site.

Regenerate the Astra CLI command reference

The Astra CLI command reference documentation is generated from the literal CLI help text in the Astra CLI code. The command reference documentation should be regenerated and committed to the docs whenever a new version of the Astra CLI is released.

  1. If you haven’t done so yet, clone the Astra CLI code repository:

    git clone https://github.com/datastax/astra-cli.git

  2. Change directory to the cloned repository:

    cd astra-cli

  3. Pull the latest changes:

    git switch main && git pull

  4. Run the following command to regenerate the command reference docs:

    source scripts/dev-alias.sh; astra docs && \
    rsync -a --delete build/docs/commands/ ~/repos/astra-cli-docs/modules/commands/pages/ && \
    cp -f build/docs/partial-nav.adoc ~/repos/astra-cli-docs/modules/commands/partials/

    Replace repos with the appropriate path to your cloned repositories.