inspec/contrib/contrib.yaml
Clinton Wolfe fa0a6c9794 Ability to render contrib resource pack docs on main website (#3184)
* Sketch out contrib doc fetcher
* Read contrib config file
* Fetch contrib resource packs from git
* Copy in resource pack docs from contrib
* Task to cleanup copied-in files
* Attach contrib resource pack docs fetching to main website doc generation
* Refactor - rename vars in resource overview task for clarity
* Generate resource overview page using info from contrib
* Fix issue in which AWS and Azure resources were ending up under OS
* Trigger contrib doc cleanup after doc build
* Comment out the contrib.yaml for now
* Disable contrib tasks if git is not available
* Rubocop issues
* Allow .md as doc file ending
* Fix for files ending in md having a relative link
* Omit 'resources' from section labels to save width
* Rubocoooooooooooppppp

Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-08-02 11:43:46 -04:00

19 lines
701 B
YAML

resource_packs: {}
# Example
# some-project:
# git_repo: the-repo-URL
# doc_sub_dir: some/oddball/path # Optional, default is docs/resources
# doc_group_title: Group Title used on website
# resource_file_regex: Regex used to identify files belonging to this group on the website
# This won't show up because the docs have the wrong file endings
# inspec-gcp:
# git_repo: https://github.com/inspec/inspec-gcp.git
# doc_group_title: GCP
# resource_file_regex: ^google_
# This is the future location of the REST-based azure resources
#inspec-azure-v2:
# git_repo: git@github.com:inspec/inspec-azure
# doc_group_title: Azure
# resource_file_regex: ^azure