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

Conversation

kuannie1
Copy link
Contributor

@kuannie1 kuannie1 commented May 12, 2020

Includes:

  • add a new component
  • adding and using a new module
  • referencing cztack/shared-infra modules
  • using remote state

@kuannie1 kuannie1 requested a review from a team as a code owner May 12, 2020 22:56
@kuannie1 kuannie1 linked an issue May 12, 2020 that may be closed by this pull request
@codecov-io
Copy link

Codecov Report

Merging #472 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #472   +/-   ##
=======================================
  Coverage   61.12%   61.12%           
=======================================
  Files          19       19           
  Lines        1955     1955           
=======================================
  Hits         1195     1195           
  Misses        607      607           
  Partials      153      153           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fc10a4b...bfc595d. Read the comment docs.

@codecov-commenter
Copy link

codecov-commenter commented May 19, 2020

Codecov Report

Merging #472 into master will not change coverage.
The diff coverage is 83.33%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #472   +/-   ##
=======================================
  Coverage   61.22%   61.22%           
=======================================
  Files          19       19           
  Lines        1960     1960           
=======================================
  Hits         1200     1200           
  Misses        607      607           
  Partials      153      153           
Impacted Files Coverage Δ
apply/apply.go 64.02% <83.33%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 12f8038...9017242. Read the comment docs.

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:

Comment on lines +96 to +98
### Typical Fogg actions
All of these snippets would belong in your project's `fogg.yml` file.
#### Add a new component
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

Comment on lines +106 to +107
#### Adding and using a new module
``` yaml
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

Comment on lines +112 to +113
#### Referencing modules from other repositories
Make sure you have `module_source` defined
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

Comment on lines +119 to +120
#### Using remote state
You will need to set some default backend details. Here's an example:
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:

@edulop91 edulop91 closed this Feb 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

typical fogg workflow documentation
5 participants