-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[feature] documentation additions #472
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -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: | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
components: | ||||||||||||
<component name here> | ||||||||||||
<add subsections yaml-style> | ||||||||||||
``` | ||||||||||||
|
||||||||||||
#### Adding and using a new module | ||||||||||||
``` yaml | ||||||||||||
Comment on lines
+106
to
+107
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
modules: | ||||||||||||
<module name>: {} | ||||||||||||
``` | ||||||||||||
|
||||||||||||
#### Referencing modules from other repositories | ||||||||||||
Make sure you have `module_source` defined | ||||||||||||
Comment on lines
+112
to
+113
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
|
||||||||||||
Format: | ||||||||||||
|
||||||||||||
`module_source: github.com/<repository slug>//<module name>?ref=<release value>` | ||||||||||||
|
||||||||||||
#### Using remote state | ||||||||||||
You will need to set some default backend details. Here's an example: | ||||||||||||
Comment on lines
+119
to
+120
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||
``` yaml | ||||||||||||
defaults: | ||||||||||||
backend: | ||||||||||||
bucket: <AWS Bucket name> | ||||||||||||
profile: <AWS Profile name> | ||||||||||||
region: <AWS Region> | ||||||||||||
``` | ||||||||||||
|
||||||||||||
## Design Principles | ||||||||||||
|
||||||||||||
### Convention over Configuration | ||||||||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.