Skip to content

Commit

Permalink
fix formatting (#6)
Browse files Browse the repository at this point in the history
* fix formatting

* update markdown tables and generall reformat all docs

* fix excerpt

* allow args to be overridden
  • Loading branch information
osterman authored May 5, 2018
1 parent 151bda4 commit f48e723
Show file tree
Hide file tree
Showing 225 changed files with 3,610 additions and 3,398 deletions.
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
export INSTALL_PATH ?= /usr/local/bin
export HUGO ?= hugo
export HUGO_URL ?= http://localhost.cloudposse.com:1313/
export HUGO_ARGS ?= --watch --buildDrafts

-include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness)

Expand All @@ -12,7 +13,7 @@ open:

## Start the hugo server for live editing
run:
@$(HUGO) server --watch --buildDrafts
@$(HUGO) server $(HUGO_ARGS)

## Generate all static content (outputs to public/)
build:
Expand Down
4 changes: 3 additions & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
---
title: "Home"
title: Home
---


6 changes: 4 additions & 2 deletions content/aws-infrastructure/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
title: "AWS Infrastructure"
excerpt: ""
title: AWS Infrastructure
excerpt: ''
---


24 changes: 9 additions & 15 deletions content/aws-infrastructure/authorization.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: "Authorization"
excerpt: ""
title: AWS IAM Authorization
excerpt: ''
---

You can access AWS by Web console or AWS CLI.

## Authorization on Web Console
# Authorization via Web Console

## Authorization for AWS CLI
# Authorization using AWS CLI

Then set up your AWS credentials in `~/.aws/credentials`. This should be shared by all AWS accounts in the Organization.

Expand All @@ -16,10 +17,9 @@ aws_access_key_id = XXXXXXXXXXXXXXXXXXXX
aws_secret_access_key = XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```

Following [IAM Best Practices](doc:best-practices) users have minimum permissions by default, but they can assume [IAM Roles](doc:assuming-roles) that provides wide access to AWS.
Following [IAM Best Practices](doc:best-practices) users have minimum permissions by default, but they can assume [IAM Roles](doc:assuming-roles) that provides wide access to AWS.

To config assume role access add AWS profile in `~/.aws/config`.
Make sure to change username to your own.
To config assume role access add AWS profile in `~/.aws/config`. Make sure to change username to your own.

```bash
[profile example-staging-admin]
Expand All @@ -29,12 +29,6 @@ mfa_serial=arn:aws:iam::XXXXXXXXXXXX:mfa/[email protected]
source_profile=example
```

In provided example:
`example` - source profile name
`example-staging-admin` - name of profile with assumed role
`role_arn` - ARN of role to assume
`mfa_serial` - use MFA ARN
`source_profile` = name of credentials to use. specified in `~/.aws/credentials`
In provided example: `example` - source profile name `example-staging-admin` - name of profile with assumed role `role_arn` - ARN of role to assume `mfa_serial` - use MFA ARN `source_profile` = name of credentials to use. specified in `~/.aws/credentials`

We recommend authorizing with assumed role profile using [AWS Vault](doc:aws-vault).
AWS vault is included in [Geodesic Overview](doc:geodesic) so you can use it in the geodesic shell
We recommend authorizing with assumed role profile using [AWS Vault](doc:aws-vault). AWS vault is included in [Geodesic Overview](doc:geodesic) so you can use it in the geodesic shell
5 changes: 3 additions & 2 deletions content/aws-infrastructure/aws-well-architected-framework.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "AWS Well-Architected Framework"
excerpt: ""
title: AWS Well-Architected Framework
excerpt: ''
draft: true
---
5 changes: 3 additions & 2 deletions content/aws-infrastructure/cloudfront.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "CloudFront"
excerpt: ""
title: CloudFront
excerpt: ''
draft: true
---
5 changes: 3 additions & 2 deletions content/aws-infrastructure/cloudtrail.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "CloudTrail"
excerpt: ""
title: CloudTrail
excerpt: ''
draft: true
---
5 changes: 3 additions & 2 deletions content/aws-infrastructure/cloudwatch-logs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "CloudWatch Logs"
excerpt: ""
title: CloudWatch Logs
excerpt: ''
draft: true
---
5 changes: 3 additions & 2 deletions content/aws-infrastructure/ecs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "ECS"
excerpt: ""
title: ECS
excerpt: ''
draft: true
---
11 changes: 8 additions & 3 deletions content/aws-infrastructure/iam/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
---
title: "IAM"
excerpt: ""
title: IAM
excerpt: ''
draft: true
tags:
- iam
- aws
---
Identity and Access Management is a system that allows managing permissions and access to AWS resources.

Identity and Access Management is a system that allows managing permissions and access to AWS resources.
9 changes: 7 additions & 2 deletions content/aws-infrastructure/iam/iam-assuming-roles.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
---
title: "IAM Assuming Roles"
excerpt: ""
title: AWS IAM Assuming Roles
excerpt: ''
draft: true
tags:
- iam
- aws
- assume-role
---
9 changes: 7 additions & 2 deletions content/aws-infrastructure/iam/iam-best-practices.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
---
title: "IAM Best Practices"
excerpt: ""
title: AWS IAM Best Practices
excerpt: ''
draft: true
tags:
- iam
- aws
- best practices
---
5 changes: 3 additions & 2 deletions content/aws-infrastructure/kms.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "KMS"
excerpt: ""
title: KMS
excerpt: ''
draft: true
---
8 changes: 6 additions & 2 deletions content/aws-infrastructure/organizations/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
title: "Organizations"
excerpt: ""
title: AWS Organizations
excerpt: ''
draft: true
tags:
- aws
- organizations
---
9 changes: 7 additions & 2 deletions content/aws-infrastructure/organizations/best-practices.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
---
title: "Best Practices"
excerpt: ""
title: AWS Organizations Best Practices
excerpt: ''
draft: true
tags:
- organizations
- aws
- best practices
---
3 changes: 2 additions & 1 deletion content/aws-infrastructure/rds.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "RDS"
title: RDS
excerpt: ""
draft: true
---
8 changes: 6 additions & 2 deletions content/aws-infrastructure/route53/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
---
title: "Route53"
excerpt: ""
title: Route53
excerpt: ''
tags:
- aws
- route53
- dns
---
15 changes: 10 additions & 5 deletions content/aws-infrastructure/route53/route53-best-practices.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: "Route 53 Best Practices"
excerpt: ""
title: Route 53 Best Practices
excerpt: ''
tags:
- dns
- aws
- best practices
---
* Use very short TTLs on `SOA` records (E.g. 60 seconds or less)
* Delegate Zones to every organization or use dedicated zones per organization (e.g. cloudposse.com, cloudposse.net, cloudposse.org)
* Use `ALIAS` records to map zone apex record to ELBs

- Use very short TTLs on `SOA` records (E.g. 60 seconds or less)
- Delegate Zones to every organization or use dedicated zones per organization (e.g. cloudposse.com, cloudposse.net, cloudposse.org)
- Use `ALIAS` records to map zone apex record to ELBs
5 changes: 3 additions & 2 deletions content/aws-infrastructure/s3.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "S3"
excerpt: ""
title: S3
excerpt: ''
draft: true
---
5 changes: 3 additions & 2 deletions content/aws-infrastructure/ssm.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "SSM"
excerpt: ""
title: SSM
excerpt: ''
draft: true
---
5 changes: 3 additions & 2 deletions content/aws-infrastructure/vpc.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "VPC"
excerpt: ""
title: VPC
excerpt: ''
draft: true
---
5 changes: 4 additions & 1 deletion content/contributors/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
---
title: "Contributors"
excerpt: ""
---
---
{{% dialog type="info" icon="fa-info-circle" title="People" %}}
⇠ Select one of the contributors on the left to learn more about them.
{{% /dialog %}}
6 changes: 5 additions & 1 deletion content/contributors/erik-osterman.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
---
title: "Erik Osterman"
excerpt: ""
tags:
- "ceo"
- "founder"
- "cloud architect"
---

Erik Osterman is a technical evangelist and insanely passionate DevOps guru with over 12 years of experience architecting systems for AWS. After leading major cloud initiatives at CBS Interactive as the *Director of Cloud Architecture*, he founded Cloud Posse, a DevOps consultancy whose sole purpose is to help high-growth Startups and Fortune 500 Companies adopt and leverage cloud-based solutions to gain the upper hand and maximize their return on investment.
Erik Osterman is a technical evangelist and insanely passionate DevOps guru with over 12 years of experience architecting systems for AWS. After leading major cloud initiatives at CBS Interactive as the *Director of Cloud Architecture*, he founded Cloud Posse, a DevOps consultancy whose sole purpose is to help high-growth Startups and Fortune 500 Companies adopt and leverage cloud-based solutions to gain the upper hand and maximize their return on investment.

Born and raised in Southern California, Erik is a 2002 graduate of UCLA, receiving a B.S. in Applied Mathematics with a specialization in Computation. He is an avid sailor, outdoorsman, skier, and tennis player, and currently resides in Pasadena, CA.

Expand Down
5 changes: 3 additions & 2 deletions content/development/12-factor-pattern.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "12 Factor Pattern"
excerpt: ""
title: 12 Factor Pattern
excerpt: ''
draft: true
---
5 changes: 4 additions & 1 deletion content/development/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
---
title: "Development"
excerpt: ""
---
---
{{% dialog type="info" icon="fa-info-circle" title="Read More" %}}
⇠ Select one of these pages to learn more about the topic.
{{% /dialog %}}
25 changes: 13 additions & 12 deletions content/development/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Code of Conduct"
excerpt: "This is our Contributor Covenant Code of Conduct."
title: Code of Conduct
excerpt: This is our Contributor Covenant Code of Conduct.
---

# Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Expand All @@ -10,19 +11,19 @@ In the interest of fostering an open and welcoming environment, we as contributo

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

# Our Responsibilities

Expand Down
7 changes: 4 additions & 3 deletions content/development/development-best-practices.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: "Development Best Practices"
excerpt: ""
title: Development Best Practices
excerpt: ''
---

# Linting

# Define `LICENSE` and/or `COPYRIGHT` file

# Include a well-formed `README.md`
# Include a well-formed `README.md`
23 changes: 15 additions & 8 deletions content/development/editor-config.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
---
title: "Editor Config"
excerpt: ""
title: Editor Config
excerpt: ''
tags:
- code style
- formatting
- .editorconfig
---

# Background

The EditorConfig enables developers to define and maintain consistent coding styles between different editors and IDEs. It consists of a simple file format (`.editorconfig`) for defining coding styles such as tabs vs spaces. Most text editors support the format and adhere to defined styles. The config files are easily readable and they work nicely with version control systems.
Expand All @@ -10,8 +15,9 @@ The EditorConfig enables developers to define and maintain consistent coding sty

Place this file in the root of your git repository.

##### .editorconfig
```text
## .editorconfig

```ini
# top-most EditorConfig file
root = true

Expand Down Expand Up @@ -61,10 +67,11 @@ indent_size = 4

# Editor Plugins

Find all plugins here: http://editorconfig.org/#download
Find all plugins here: <http://editorconfig.org/#download>

* [Vim](https://github.com/editorconfig/editorconfig-vim#readme)
* [Visual Studio](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
- [Vim](https://github.com/editorconfig/editorconfig-vim#readme)
- [Visual Studio](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)

# References
* http://editorconfig.org/

- <http://editorconfig.org/>
Loading

0 comments on commit f48e723

Please sign in to comment.