Skip to content
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

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment on lines +96 to +98
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Typical Fogg actions
All of these snippets would belong in your project's `fogg.yml` file.
#### Add a new component
### Typical Fogg actions
All of these snippets would belong in your project's `fogg.yml` file.
#### Add a new component

``` yaml
section_name:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
section_name:
env_name:

components:
<component name here>
<add subsections yaml-style>
```

#### Adding and using a new module
``` yaml
Comment on lines +106 to +107
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Adding and using a new module
``` yaml
#### Adding and using a new module
``` yaml

modules:
<module name>: {}
```

#### Referencing modules from other repositories
Make sure you have `module_source` defined
Comment on lines +112 to +113
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Referencing modules from other repositories
Make sure you have `module_source` defined
#### Referencing modules from other repositories
Make sure you have `module_source` defined


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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Using remote state
You will need to set some default backend details. Here's an example:
#### Using remote state
You will need to set some default backend details. Here's an example:

``` yaml
defaults:
backend:
bucket: <AWS Bucket name>
profile: <AWS Profile name>
region: <AWS Region>
```

## Design Principles

### Convention over Configuration
Expand Down