Skip to content

Commit c22c333

Browse files
ostermangoruha
authored andcommitted
replace all remaining doc: refs (#21)
1 parent 0dbcb72 commit c22c333

File tree

16 files changed

+50
-22
lines changed

16 files changed

+50
-22
lines changed
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
title: AWS Well-Architected Framework
33
excerpt: ''
4-
draft: true
54
---

content/aws/organizations/best-practices.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: AWS Organizations Best Practices
33
excerpt: ''
4-
draft: true
54
tags:
65
- organizations
76
- aws
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
22
title: 12 Factor Pattern
33
excerpt: ''
4-
draft: true
54
---

content/geodesic/geodesic-design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: -1
88

99
We designed this shell as the last layer of abstraction. It stitches all the tools together like `make`, `aws-cli`, `kops`, `helm`, `kubectl`, and `terraform`. As time progresses, there will undoubtedly be even more that come into play. For this reason, we chose to use a combination of `bash` and `make` which together are ideally suited to combine the strengths of all these wonderful tools into one powerful shell, without raising the barrier to entry too high.
1010

11-
For the default environment variables, check out `Dockerfile`. We believe using ENVs this way is both consistent with the "cloud" ([12 Factor Pattern](doc:12-factor-pattern)) way of doing things, as well as a clear way of communicating what values are being passed without using a complicated convention. Additionally, you can set & forget these ENVs in your shell.
11+
For the default environment variables, check out `Dockerfile`. We believe using ENVs this way is both consistent with the "cloud" ([12 Factor Pattern]({{< relref "development/12-factor-pattern.md" >}})) way of doing things, as well as a clear way of communicating what values are being passed without using a complicated convention. Additionally, you can set & forget these ENVs in your shell.
1212

1313
# Layout Inside the Shell
1414

@@ -24,4 +24,4 @@ We leverage as many semantics of the linux shell as we can to make the experienc
2424
| `/localhost` | is where we house the local state (like your temporary AWS credentials). This is your native `$HOME` directory mounted into the container. |
2525
| `/s3` | is where we mount S3 buckets; these files are never written to disk and only kept in memory for security |
2626

27-
You can easily change almost any aspect of how the shell works simply by extending it with [Geodesic Module](doc:module)
27+
You can easily change almost any aspect of how the shell works simply by extending it with [Geodesic Module](/geodesic/module)

content/geodesic/module/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ docker run -e CLUSTER_NAME \
3535

3636
# Configure Project
3737

38-
Customize module files as necessary. Edit the `Dockerfile` to reflect your settings. The files are installed to the `$CLUSTER_NAME/` folder. We recommend creating a [GitHub](doc:github) repo to store this configuration.
38+
Customize module files as necessary. Edit the `Dockerfile` to reflect your settings. The files are installed to the `$CLUSTER_NAME/` folder. We recommend creating a [GitHub]({{< relref "documentation/our-github.md" >}}) repo to store this configuration.
3939

4040
```
4141
cd $CLUSTER_NAME
@@ -64,7 +64,7 @@ make install
6464
## Run the shell
6565

6666
The shell can now be easily started any time by simply running `$CLUSTER_NAME`, which is a shell script in `/usr/local/bin`. Make sure this path is in your `PATH` environment variable.
67-
For more information follow [Use](doc:use)
67+
For more information follow [Use](/geodesic/module/usage/)
6868

6969
# Authorize on AWS
7070

content/geodesic/module/usage/with-kops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ excerpt: ""
88
99
# Create a cluster
1010

11-
Follow the [Provision a Cluster](doc:provision-a-cluster) process
11+
Follow the [Provision a Cluster]({{< relref "geodesic/module/usage/with-kops.md" >}}) process
1212

1313
# Provision Platform Backing Services
1414

content/geodesic/module/usage/with-terraform.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Then run these commands:
2929
5. Re-run `init-terraform`, answer `yes` when asked to import state
3030

3131
{{% dialog type="warning" icon="fa-exclamation-circle" title="Prerequisites" %}}
32-
Follow the "Use geodesic module" to [Use](doc:use) get how to use the module shell.
32+
Follow the "Use geodesic module" to [Use](/geodesic/module/usage/) get how to use the module shell.
3333
{{% /dialog %}}
3434

3535
# Create terraform state bucket
@@ -120,13 +120,13 @@ ENV TF_VAR_tfstate_region=us-west-2
120120
```
121121

122122
## Rebuild module
123-
[Rebuild](doc:use) the module
123+
[Rebuild](/geodesic/module/usage/) the module
124124
```bash
125125
> make build
126126
```
127127

128128
## Run into the module shell
129-
Run Geodesic Shell in [development mode](doc:use#section-development-mode)
129+
Run Geodesic Shell in [development mode](/geodesic/module/usage/#section-development-mode)
130130
```bash
131131
> $CLUSTER_NAME
132132
```
@@ -250,13 +250,13 @@ ENV TF_DYNAMODB_TABLE "example-staging-terraform-state-lock"
250250
```
251251
252252
## Rebuild the module
253-
[Rebuild](doc:use) the module
253+
[Rebuild](/geodesic/module/usage/) the module
254254
```bash
255255
> make build
256256
```
257257
258258
## Run into the module shell and authorize on AWS
259-
Run Geodesic Shell in [development mode](doc:use#section-development-mode)
259+
Run Geodesic Shell in [development mode](/geodesic/module/usage/#section-development-mode)
260260
```bash
261261
> $CLUSTER_NAME
262262
> assume-role

content/glossary/12-factor.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: 12-Factor
3+
terms:
4+
- "12f"
5+
- "12-factor"
6+
- "12 factor"
7+
- "12 factor pattern"
8+
- "12-factor pattern"
9+
excerpt: ""
10+
---
11+
The 12 Factor Pattern is a software methodology for building cloud-friendly (or cloud-native), scalable, maintainable applications that deploy easily on a Platform-as-a-Service (aka PaaS).

content/glossary/paas.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Platform-as-a-Service (PaaS)
3+
terms:
4+
- "PaaS"
5+
- "Platform as a Service"
6+
- "Platform-as-a-Service"
7+
excerpt: ""
8+
---
9+
A Platform-as-a-Service is a type of cloud platform which offers black-box services that enable developers to build applications on top of the compute infrastructure without needing to deal with the day-to-day maintenance of the infrastructure. This might include developer tools that are offered as a service to build services, or data access and database services, or billing services.

content/glossary/saas.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Software-as-a-Service (SaaS)
3+
terms:
4+
- "SaaS"
5+
- "Software as a Service"
6+
- "Software-as-a-Service"
7+
excerpt: ""
8+
---
9+
Sofware-as-a-Service is a form of a cloud services platform, whereby the computing platform (operating system and associated services) is delivered as a service over the Internet by the provider.
10+
11+

0 commit comments

Comments
 (0)