Foundation Docs Template

Source code & Installation

The source code of this kit module can be found here

Run the following command to install the kit module:

collie kit import foundation/docs

This documentation is intended as a reference documentation for cloud foundation or platform engineers using this module.

Requirements

Name	Version
local	2.5.1
null	3.2.2

Modules

No modules.

Resources

Name	Type
local_file.module_docs	resource
local_file.platform_readmes	resource
null_resource.copy_compliance	resource
null_resource.copy_template	resource
terraform_remote_state.docs_azure	data source

Inputs

Name	Description	Type	Default	Required
foundation_dir	path to the collie foundation directory for this foundation	string	n/a	yes
output_dir	path to the directory where to store the generated documentation output	string	n/a	yes
platforms	platform configuration required to produce docs	object({ azure = object({ aad_tenant_id = string subscription_id = string tfstateconfig = object({ resource_group_name = string storage_account_name = string container_name = string }) }) })	n/a	yes
repo_dir	path to the collie repository directory	string	n/a	yes
template_dir	path to the directory containing the docs site template	string	n/a	yes

Outputs

No outputs.