From bfc595d2f1bb29acd8090bc9fdacedaf53547061 Mon Sep 17 00:00:00 2001 From: Annie Date: Tue, 12 May 2020 15:54:32 -0700 Subject: [PATCH] Documentation contribution --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index c3f5f3545..f310b3972 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,39 @@ fogg completion bash > $(brew --prefix)/etc/bash_completion.d/fogg You can add the file generated by `fogg completion zsh` to a directory in your $fpath. +### Typical Fogg actions +All of these snippets would belong in your project's `fogg.yml` file. +#### Add a new component +``` yaml +section_name: + components: + + +``` + +#### Adding and using a new module +``` yaml +modules: + : {} +``` + +#### Referencing modules from other repositories +Make sure you have `module_source` defined + +Format: + +`module_source: github.com///?ref=` + +#### Using remote state +You will need to set some default backend details. Here's an example: +``` yaml +defaults: + backend: + bucket: + profile: + region: +``` + ## Design Principles ### Convention over Configuration