github.com/juju/juju@v0.0.0-20240430160146-1752b71fcf00/scripts/md-gen/controller-config/README.md (about)

     1  # md-gen/controller-config
     2  
     3  This script generates a Markdown reference doc for the controller config keys,
     4  based on the code in the `github.com/juju/juju/controller` package.
     5  
     6  It requires the following environment variables to be set:
     7  - `DOCS_DIR`: the directory in which to place the outputted Markdown doc
     8  - `JUJU_SRC_ROOT`: the root directory of a local checked-out copy of the
     9    Juju source tree (`github.com/juju/juju`). This is used to locate the
    10    `controller` package and parse it into an AST to gather information e.g.
    11    doc comments.
    12  
    13  Assuming you're in the root of the Juju source tree, you can invoke the script
    14  like so:
    15  ```bash
    16  export DOCS_DIR=$(pwd)/docs
    17  export JUJU_SRC_ROOT=$(pwd)
    18  go run ./scripts/md-gen/controller-config
    19  ```