Skip to content

Commit

Permalink
Import documentation from Readme.io (#1)
Browse files Browse the repository at this point in the history
* Added export from readme.io

* Added preprocess state

* Processed

* Change file strucutre
  • Loading branch information
goruha authored and osterman committed May 1, 2018
1 parent 79ea82d commit 7d5baa2
Show file tree
Hide file tree
Showing 962 changed files with 77,510 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +0,0 @@
# docs
Cloud Posse Developer Hub Documentation
173 changes: 173 additions & 0 deletions _mdwriter.cson
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
# Markdown-Writer for Atom
# https://atom.io/packages/markdown-writer
#
# To find latest and default configurations, refer to:
# https://github.com/zhuochun/md-writer/blob/master/lib/config.cson
#
# Examples: https://github.com/zhuochun/md-writer/wiki/Settings#example-customizations
#
# NOTE 1: After edit, please run command `Window: Reload` or
# Use menu: View -> Developer -> Reload Window.
# NOTE 2: Strings need to be quoted.
#

# Static engine of your blog
# - One of: general, html, jekyll, octopress, hexo
siteEngine: "general"
# Website URL of your blog
siteUrl: ""

# Root directory to your blog
# - Leave it empty to use the current project path (recommended)
siteLocalDir: ""
# Directory to drafts from siteLocalDir
siteDraftsDir: "_drafts/"
# Directory to posts from siteLocalDir
sitePostsDir: "_posts/{year}/"
# Directory to images from siteLocalDir
# - E.g. to use the current filename directory, can use {directory}
siteImagesDir: "static/images/"

# URLs to tags/posts/categories JSON files
# https://github.com/zhuochun/md-writer/wiki/Settings-for-Front-Matters
urlForPosts: ""
urlForTags: ""
urlForCategories: ""

# The front matter key name
frontMatterNameTags: "tags"
frontMatterNameCategories: "categories"

# Filename format of new drafts created
newDraftFileName: "{slug}{extension}"
# Filename format of new posts created
newPostFileName: "{slug}{extension}"

# Front matter date format, determines the {date} in frontMatter
frontMatterDate: "{year}-{month}-{day} {hour}:{minute}"
# Front matter template
frontMatter: """
---
layout: "{layout}"
title: "{title}"
date: "{date}"
---
"""

# File extension of posts/drafts
fileExtension: ".md"
# File slug separator
slugSeparator: "-"

# Rename filename based on title in front matter when publishing
publishRenameBasedOnTitle: false
# Publish keep draft's extension name used
publishKeepFileExtname: false

# List continuation in the middle of line
# - Enable to start a new list whenever you press enter in a list
# - Disable to start a new list only when you press enter at the end of a list
inlineNewLineContinuation: false
# Ordered list number continuation
# - Enable to continue numbers from previous number in ordered lists
# - Disable to always use 1. as the number in ordered lists
orderedNewLineNumberContinuation: true
# Table row continuation
# - Enable to auto insert table columns when you press enter in a table row
tableNewLineContinuation: true

# Path to a cson file that stores links added for automatic linking
# - Config is commented so to use the default `markdown-writer-links.cson` file
# under your Atom global config directory
# siteLinkPath: "set/path/to/links.cson"

# TextStyles and LineStyles
#
# - Use `before` and `after` to insert text around the selected text.
# - Use `regexMatch{Before,After}` when an exact match of the style is needed.
# If this regex matched true, the style will be toggled.
# - Use `regex{Before,After}` when a general match of the style is wanted.
# If this regex matched true, the style will be replaced by new style.
#
# NOTE
#
# - In `regex{Before,After}`, `regexMatch{Before,After}`, DO NOT USE CAPTURE GROUP!
# Capture group will break things! USE non-capturing group `(?:)` instead.
# - When `regexMatch{Before,After}` is not specified, `regex{Before,After}` is used instead.
# - In nested settings, e.g. codeblock, ul, ol, all the within nested keys need to exists if
# you changed one setting.
#
textStyles:
code:
before: "`", after: "`"
bold:
before: "**", after: "**"
italic:
before: "_", after: "_"
keystroke:
before: "<kbd>", after: "</kbd>"
strikethrough:
before: "~~", after: "~~"
codeblock:
before: "```\n"
after: "\n```"
regexBefore: "```(?:[\\w- ]+)?\\r?\\n"
regexAfter: "\\r?\\n```"

lineStyles:
h1: before: "# "
h2: before: "## "
h3: before: "### "
h4: before: "#### "
h5: before: "##### "
ul:
before: "{ul} "
regexMatchBefore: "(?:-|\\*|\\+|\\.)\\s"
regexBefore: "(?:-|\\*|\\+|\\.|\\d+[\\.\\)]|[a-zA-Z]+[\\.\\)])\\s"
ol:
before: "{i}. "
regexMatchBefore: "(?:\\d+[\\.\\)]|[a-zA-Z]+[\\.\\)])\\s"
regexBefore: "(?:-|\\*|\\+|\\.|\\d+[\\.\\)]|[a-zA-Z]+[\\.\\)])\\s"
task:
before: "{ul} [ ] "
regexMatchBefore: "(?:-|\\*|\\+|\\d+[\\.\\)])\\s+\\[ ]\\s"
regexBefore: "(?:-|\\*|\\+|\\d+[\\.\\)]|[a-zA-Z]+[\\.\\)])\\s*(?:\\[[xX ]])?\\s"
taskdone:
before: "{ul} [x] "
regexMatchBefore: "(?:-|\\*|\\+|\\d+[\\.\\)])\\s+\\[[xX]]\\s"
regexBefore: "(?:-|\\*|\\+|\\d+[\\.\\)]|[a-zA-Z]+[\\.\\)])\\s*(?:\\[[xX ]])?\\s"
blockquote: before: "> "

# Image tag template
imageTag: "![{alt}]({src})"
# Use relative path to image from the opened file
relativeImagePath: true
# Rename copyed image based on title/alt
renameImageOnCopy: false

# Inline link tag template
linkInlineTag: "[{text}]({url})"
# Reference link tag template
referenceInlineTag: "[{text}][{label}]"
referenceDefinitionTag: '{indent}[{label}]: {url} "{title}"'
# Reference link tag insert position: "paragraph", "article"
referenceInsertPosition: "paragraph"
# Reference link tag indent space: 0, 2
referenceIndentLength: 2

# Footnote tag template
footnoteReferenceTag: "[^{label}]"
footnoteDefinitionTag: "[^{label}]: {content}"
# Footnote definition tag insert position: "paragraph", "article"
footnoteInsertPosition: "paragraph"

# Table default alignments: "empty", "left", "right", "center"
tableAlignment: "empty"
# Insert extra pipes at the beginning and the end of table rows
tableExtraPipes: false

# Template variables is a key-value map used in template string
templateVariables:
# Bullet for unordered list. add ulBullet1, ulBullet2 if you want different bullet for nested list
# https://github.com/zhuochun/md-writer/wiki/Settings#use-different-unorder-list
ulBullet: "-"
6 changes: 6 additions & 0 deletions archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

62 changes: 62 additions & 0 deletions config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
baseURL = "http://example.org/"
languageCode = "en-us"
title = "Cloudposse"
theme = "hugo-theme-docdock"
pygmentsCodeFences = true
pygmentsStyle = "monokailight"

defaultContentLanguage = "en"
defaultContentLanguageInSubdir= false
enableMissingTranslationPlaceholders = false

enableEmoji = true
# [Languages]
# [Languages.en]
# title = "Documentation for Hugo docDock"
# weight = 1
# languageName = "English"
#
# [Languages.fr]
# title = "Documentation du thème docDock"
# weight = 2
# languageName = "Français"


[params]
showVisitedLinks = true # default is false
themeStyle = "flex" # "original" or "flex" # default "flex"
themeVariant = "" # choose theme variant "green", "gold" , "gray", "blue" (default)
ordersectionsby = "weight" # ordersectionsby = "title"
disableHomeIcon = false # default is false
disableSearch = false # default is false
disableNavChevron = false # set true to hide next/prev chevron, default is false
highlightClientSide = false # set true to use highlight.pack.js instead of the default hugo chroma highlighter
menushortcutsnewtab = false # set true to open shortcuts links to a new tab/window
enableGitInfo = false

[outputs]
home = [ "HTML", "RSS", "JSON"]


[[menu.shortcuts]]
pre = "<h3>More</h3>"
name = "<i class='fa fa-github'></i> <label>Github repo</label>"
identifier = "ds"
url = "https://github.com/vjeantet/hugo-theme-docdock"
weight = 10

[[menu.shortcuts]]
name = "<i class='fa fa-cloud-download'></i> <label>Download</label>"
url = "https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip"
weight = 11

[[menu.shortcuts]]
name = "<i class='fa fa-bookmark'></i> <label>Hugo Documentation</label>"
identifier = "hugodoc"
url = "https://gohugo.io/"
weight = 20

[[menu.shortcuts]]
name = "<i class='fa fa-bullhorn'></i> <label>Credits</label>"
url = "/credits"
weight = 30
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/AWS Well-Architected Framework.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "AWS Well-Architected Framework"
excerpt: ""
---
40 changes: 40 additions & 0 deletions content/AWS Infrastructure/Authorization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "Authorization"
excerpt: ""
---
You can access AWS by Web console or AWS CLI.

## Authorization on Web Console

## Authorization for AWS CLI

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

```bash
[example]
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.

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

```bash
[profile example-staging-admin]
region=us-west-2
role_arn=arn:aws:iam::XXXXXXXXXXXX:role/OrganizationAccountAccessRole
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`

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
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/CloudFront.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "CloudFront"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/CloudTrail.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "CloudTrail"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/CloudWatch Logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "CloudWatch Logs"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/ECS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "ECS"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/IAM/IAM Assuming Roles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "IAM Assuming Roles"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/IAM/IAM Best Practices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "IAM Best Practices"
excerpt: ""
---
5 changes: 5 additions & 0 deletions content/AWS Infrastructure/IAM/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "IAM"
excerpt: ""
---
Identity and Access Management is a system that allows managing permissions and access to AWS resources.
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/KMS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "KMS"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/Organizations/Best Practices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Best Practices"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/Organizations/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Organizations"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/RDS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "RDS"
excerpt: ""
---
7 changes: 7 additions & 0 deletions content/AWS Infrastructure/Route53/Route 53 Best Practices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Route 53 Best Practices"
excerpt: ""
---
* 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
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/Route53/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "Route53"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/S3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "S3"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/SSM.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "SSM"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/VPC.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "VPC"
excerpt: ""
---
4 changes: 4 additions & 0 deletions content/AWS Infrastructure/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: "AWS Infrastructure"
excerpt: ""
---
Loading

0 comments on commit 7d5baa2

Please sign in to comment.