Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

StackQL Doc Autogeneration

Used to generate markdown docs for stackql providers using provider metadata from the StackQL Provider Registry.

Setup

Add or update the required provider metadata to docgen/provider_data.py.

Download the latest version:

curl -L https://bit.ly/stackql-zip -O \
&& unzip stackql-zip

Usage

sh docgen.sh <provider>

for example...

sh docgen.sh google

This command would generate the docs for the latest version of the google StackQL provider, the docs would be created in the docs/google folder, once they are verified the docs can be moved to /docs/providers/google.

if you wanted to generate docs for a specific version you could provide that version as the second argument, for example: sh docgen.sh google v23.03.00130

Publishing Docs

Once the docs have been generated and verified they can be published to docs dir at the root of this project by running the following command:

sh publish.sh <provider>

for example...

sh publish.sh google