Skip to content

Commit

Permalink
customize header (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
osterman authored May 4, 2018
1 parent 7d5baa2 commit f198706
Show file tree
Hide file tree
Showing 54 changed files with 1,700 additions and 86 deletions.
14 changes: 14 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Override for Makefile
[{Makefile, makefile, GNUmakefile}]
indent_style = tab
indent_size = 4

[Makefile.*]
indent_style = tab
indent_size = 4

[*.md]
indent_style = space
indent_size = 2


5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
node_modules
.build-harness
build-harness/
public/*
.gitkeep
*.swp
19 changes: 19 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
export INSTALL_PATH ?= /usr/local/bin
export HUGO ?= hugo
export HUGO_URL ?= http://localhost.cloudposse.com:1313/

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

## Install package dependencies
deps: packages/install/hugo

open:
open $(HUGO_URL)

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

## Generate all static content (outputs to public/)
build:
@$(HUGO)
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Algolia

- https://forestry.io/blog/search-with-algolia-in-hugo/
- https://github.com/gohugoio/hugo/pull/2016

# Usage

1. Run `make init`
2. Run `make run` to start local server

# Glossary

Update [`glossary.json`](static/js/glossary.json)



55 changes: 38 additions & 17 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
baseURL = "http://example.org/"
baseURL = "http://localhost.cloudposse.com:1313/"
languageCode = "en-us"
title = "Cloudposse"
title = "Cloud Posse Developer Hub"
theme = "hugo-theme-docdock"
pygmentsCodeFences = true
pygmentsStyle = "monokailight"
Expand All @@ -25,10 +25,9 @@ enableEmoji = true
[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
disableHomeIcon = true
disableSearch = true
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
Expand All @@ -37,26 +36,48 @@ enableGitInfo = false
[outputs]
home = [ "HTML", "RSS", "JSON"]

[[menu.shortcuts]]
pre = "<h3>More</h3>"
name = "<i class='fa fa-github'></i> <label>Documentation</label>"
identifier = "documentation"
url = "/"
weight = 10

[[menu.shortcuts]]
pre = "<h3>More</h3>"
name = "<i class='fa fa-github'></i> <label>Support</label>"
identifier = "support"
url = "https://github.com/cloudposse/docs/issues"
weight = 20

[[menu.shortcuts]]
pre = "<h3>More</h3>"
name = "<i class='fa fa-github'></i> <label>Ask a Question</label>"
identifier = "ask-a-question"
url = "https://github.com/cloudposse/docs/issues/new"
weight = 30

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

[[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
name = "<i class='fa fa-cloud-download'></i> <label>Announcements</label>"
identifier = "announcements"
url = "/announcements"
weight = 50

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

[[menu.shortcuts]]
name = "<i class='fa fa-bullhorn'></i> <label>Credits</label>"
url = "/credits"
weight = 30
name = "<i class='fa fa-bullhorn'></i> <label>Contact Us</label>"
url = "/contact-us"
identifier = "contact-us"
weight = 70
3 changes: 2 additions & 1 deletion content/Contributors/Erik Osterman.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Erik Osterman"
excerpt: ""
---

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 All @@ -12,4 +13,4 @@ Born and raised in Southern California, Erik is a 2002 graduate of UCLA, receivi
|Blog|https://osterman.com/|


![](/images/ba3ae6b-erik_osterman.png)
![](/images/ba3ae6b-erik_osterman.png)
1 change: 1 addition & 0 deletions content/Documentation/Contact Us.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Contact Us"
excerpt: ""
parent: "home"
---

|||
Expand Down
2 changes: 1 addition & 1 deletion content/Geodesic/Geodesic Module/Quick start.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Config AWS credentials and roles following [Authorization](doc:authorization)
##### :warning: Warning
> Geodesic use [AWS Vault](doc:aws-vault) to authorize on AWS so ensure you add source profile name to [AWS Vault](doc:aws-vault)
## Set default profile in <<glossary:Module>>
## Set default profile in Geodesic Module

Add to you module `Dockerfile` :

Expand Down
14 changes: 7 additions & 7 deletions content/Geodesic/Geodesic Module/Use/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,27 @@ excerpt: ""
# Run shell

<<glossary:Module>> is docker container that extends <<glossary:Geodesic>> and used as a shell.
A Geodesic Module is docker container that extends Geodesic and used as a shell.

<<glossary:Module>> have a unique name. The shell can be easily started any time by simply running that name in a terminal.
Each Geodesic Module will have a unique name. The shell can be easily started any time by simply running that name in a terminal.
The name is a shell script in `/usr/local/bin`. Make sure this path is in your `PATH` environment variable.

## Development mode

If you create <<glossary:Module>> with [scaffolding](doc:quickstart) there would be `/conf` directory in <<glossary:Module>> directory.
If you create a Geodesic Module with [scaffolding](doc:quickstart) there would be `/conf` directory in Geodesic Module directory.
'/conf' dir used to store [Backing Services](doc:scafflod).
If you run <<glossary:Module>> shell with flag `--dev` it will share local `./conf` directory into <<glossary:Module>> container `/conf`.
If you run Geodesic Module shell with flag `--dev` it will share local `./conf` directory into Geodesic Module container `/conf`.
This is very useful when you developing [Backing Services](doc:scafflod).

When the development finished, you need rebuild <<glossary:Module>> container to add [Backing Services](doc:scafflod) in the module container.
When the development finished, you need rebuild Geodesic Module container to add [Backing Services](doc:scafflod) in the module container.

# Build new version

To build <<glossary:Module>> just run `make build` in the module directory
To build Geodesic Module just run `make build` in the module directory

# Use shell

When you run into the shell you need to authorize on AWS by assuming a correct role and then you can work with tools build in <<glossary:Geodesic>>
When you run into the shell you need to authorize on AWS by assuming a correct role and then you can work with tools build in Geodesic Module.

##### Example
```shell
Expand Down
6 changes: 3 additions & 3 deletions content/Geodesic/Geodesic Module/Use/with Terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ ENV TF_VAR_tfstate_region=us-west-2
```

## Run into the module shell
Run <<glossary:Module>> shell in [development mode](doc:use#section-development-mode)
Run Geodesic Shell in [development mode](doc:use#section-development-mode)
```bash
> $CLUSTER_NAME --dev
```
Expand Down Expand Up @@ -251,7 +251,7 @@ ENV TF_DYNAMODB_TABLE "example-staging-terraform-state-lock"
```
## Run into the module shell and authorize on AWS
Run <<glossary:Module>> shell in [development mode](doc:use#section-development-mode)
Run Geodesic Shell in [development mode](doc:use#section-development-mode)
```bash
> $CLUSTER_NAME --dev
> assume-role
Expand Down Expand Up @@ -392,4 +392,4 @@ Repeat for all other projects in the solution (`dns`, `acm`, etc.).
Run `make docker/build` to build terraform modules in geodesic shell container.
All done. All AWS resources are now up and running.
All done. All AWS resources are now up and running.
3 changes: 2 additions & 1 deletion content/Geodesic/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Geodesic"
excerpt: "Geodesic is the fastest way to get up and running with a rock solid, production-grade cloud platform."
homepage: true
---
![](/images/638d917-geodesic-small.png)

Expand Down Expand Up @@ -63,4 +64,4 @@ In mathematics, a geodesic line is the shortest distance between two points on a

We like to think of geodesic as the shortest path to a rock-solid cloud infrastructure. The geodesic logo is a hexagon with a cube suspended at its center. The cube represents this geodesic container, which is central to everything and at the same time is what ties everything together.

But look a little closer and you’ll notice there’s much more to it. It's also an isometric shape of a cube with a missing piece. This represents its pluggable design, which lets anyone extend it to suit their vision.
But look a little closer and you’ll notice there’s much more to it. It's also an isometric shape of a cube with a missing piece. This represents its pluggable design, which lets anyone extend it to suit their vision.
4 changes: 2 additions & 2 deletions content/Learn By Example/Agenda.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ As a continuous integration platform, they choose Codefresh.io.

## Game Plan

Following [AWS Well-Architected Framework](doc:aws-well-architected-framework) and [Best Practices](doc:aws-organizations-best-practices) we will create 3 AWS organizations belongs to root AWS account and 4 <<glossary:Module>>:
Following [AWS Well-Architected Framework](doc:aws-well-architected-framework) and [Best Practices](doc:aws-organizations-best-practices) we will create 3 AWS organizations belongs to root AWS account and 4 Geodesic Modules:
* `root.example.com` - Module for root AWS account
* `staging.example.com` - Module for the staging environment
* `development.example.com` - Module for the development environment
Expand All @@ -29,4 +29,4 @@ Following [AWS Well-Architected Framework](doc:aws-well-architected-framework) a
----------

`root.example.com` - will be responsible for managing users, creation [Organizations](doc:organizations) for environments and grant access to them.
All other Modules will spin up <<glossary:Kubernetes>> where applications will be executed
All other Modules will spin up Kubernetes where applications will be executed
3 changes: 2 additions & 1 deletion content/Local Development Environments/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: "Local Development Environments"
excerpt: ""
---
homepage: true
---
5 changes: 3 additions & 2 deletions content/Terraform Modules/Terraform Backup Modules/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform Backup Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
5 changes: 3 additions & 2 deletions content/Terraform Modules/Terraform CDN Modules/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform CDN Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
6 changes: 4 additions & 2 deletions content/Terraform Modules/Terraform CI-CD Modules/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,7 @@ title: "Terraform CI/CD Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}

Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform Database Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform Kubernetes (Kops) Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
5 changes: 3 additions & 2 deletions content/Terraform Modules/Terraform Logging Modules/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform Logging Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform Monitoring Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform Networking Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform Platform Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform Security Modules"
excerpt: ""
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Terraform User Data Modules"
excerpt: "User Data modules provide shell scripts that are useful as \"cloud init\" scripts passed to EC2 instances."
---

##### :information_source: MODULE DOCUMENTATION
> ⇠ Select one of the modules on the left to view the documentation
{{% notice note %}}
⇠ Select one of the modules on the left to view the documentation
{{% /notice %}}
3 changes: 2 additions & 1 deletion content/Terraform/Terraform Best Practices.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Terraform Best Practices"
excerpt: ""
slug: "terraform-best-practices"
---
![](/images/08bcd99-terraform.png)

Expand Down Expand Up @@ -153,4 +154,4 @@ Example:

# Module Design

# Module Usage
# Module Usage
Loading

0 comments on commit f198706

Please sign in to comment.