Skip to content

docs: improvement of formatting in documentation #2290

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Next create a second terraform workspace and initiate the module, or adapt one o

Note that `github_app.key_base64` needs to be a base64-encoded string of the `.pem` file i.e. the output of `base64 app.private-key.pem`. The decoded string can either be a multiline value or a single line value with new lines represented with literal `\n` characters.

```terraform
```hcl
module "github-runner" {
source = "philips-labs/github-runner/aws"
version = "REPLACE_WITH_VERSION"
Expand Down Expand Up @@ -244,7 +244,6 @@ module "runners" {
...
kms_key_arn = aws_kms_key.github.arn
...

```

### Pool
Expand Down Expand Up @@ -506,16 +505,14 @@ We welcome contribution, please checkout the [contribution guide](CONTRIBUTING.m

This module is part of the Philips Forest.

```bash

```plain
___ _
/ __\__ _ __ ___ ___| |_
/ _\/ _ \| '__/ _ \/ __| __|
/ / | (_) | | | __/\__ \ |_
\/ \___/|_| \___||___/\__|

Infrastructure

```

Talk to the forestkeepers in the `runners`-channel on Slack.
Expand Down
6 changes: 3 additions & 3 deletions docs/test-lambda-local.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ output "development" {
value = {
lambda_syncer = module.runners.binaries_syncer.lambda
}
}```
}
```

Once you have updated your Terraform deployment you need to read the lambda configuration into your environment. Run the commands below in your Terraform workspace folder.

Expand All @@ -60,7 +61,7 @@ role_arn=<ARN_CHECK_TF_OUTPUT>

Now you can set the profile and region as environment variables or pass as argument to SAM.

```
```bash
export AWS_REGION=<region>
export AWS_PROFILE=gh-development
```
Expand All @@ -75,7 +76,6 @@ Instead of using SAM you can use Node with `ts-node-dev` to test the code locall
The AWS SDK does not seem to handle environment variables for profiles, the only option to pass the role is via credentials. You can get credentials via STS for the role.

```bash

role=$(aws sts assume-role \
--role-arn "<ROLE>" \
--duration-seconds 3600 --role-session-name "dev")
Expand Down
1 change: 0 additions & 1 deletion examples/prebuilt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ To use your image in the terraform modules you will need to set some values on t
Assuming you have built the `linux-amzn2` image which has a pre-defined AMI name in the following format `github-runner-amzn2-x86_64-YYYYMMDDhhmm` you can use the following values.

```hcl

module "runners" {
...
# set the name of the ami to use
Expand Down
12 changes: 5 additions & 7 deletions modules/download-lambda/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ This module is optional and provides an option to download via Terraform the Lam

## Usages

```
```hcl
module "lambdas" {
source = "<source location>"
lambdas = [
{
name = "webhook"
tag = "v0.11.0"
tag = "v0.15.0"
},
{
name = "runners"
tag = "v0.11.0"
tag = "v0.15.0"
},
{
name = "runner-binaries-syncer"
tag = "v0.11.0"
tag = "v0.15.0"
}
]
}
Expand Down Expand Up @@ -65,16 +65,14 @@ No modules.

This module is part of the Philips Forest.

```

```plain
___ _
/ __\__ _ __ ___ ___| |_
/ _\/ _ \| '__/ _ \/ __| __|
/ / | (_) | | | __/\__ \ |_
\/ \___/|_| \___||___/\__|

Infrastructure

```

Talk to the forestkeepers in the `forest`-channel on Slack.
Expand Down
4 changes: 1 addition & 3 deletions modules/runner-binaries-syncer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,16 +122,14 @@ No modules.

This module is part of the Philips Forest.

```

```plain
___ _
/ __\__ _ __ ___ ___| |_
/ _\/ _ \| '__/ _ \/ __| __|
/ / | (_) | | | __/\__ \ |_
\/ \___/|_| \___||___/\__|

Infrastructure

```

Talk to the forestkeepers in the `forest`-channel on Slack.
Expand Down
4 changes: 1 addition & 3 deletions modules/runners/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,16 +209,14 @@ yarn run dist

This module is part of the Philips Forest.

```

```plain
___ _
/ __\__ _ __ ___ ___| |_
/ _\/ _ \| '__/ _ \/ __| __|
/ / | (_) | | | __/\__ \ |_
\/ \___/|_| \___||___/\__|

Infrastructure

```

Talk to the forestkeepers in the `forest`-channel on Slack.
Expand Down
7 changes: 2 additions & 5 deletions modules/setup-iam-permissions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This module will create an AWS IAM role that is required to use permission bound
See below or check out [this example](../../examples/permissions-boundary/README.md)
Create a workspace and add the following terraform code.

```
```hcl
module "iam" {
source = "../../"

Expand All @@ -31,7 +31,6 @@ output "role" {
output "boundary" {
value = module.iam.boundary
}

```

Next execute the created Terraform code `terraform init && terraform apply` The module will. You can use the created role in your terraform provider with assume role and the boundary as well the namespace needs to be set to the root module.
Expand Down Expand Up @@ -87,16 +86,14 @@ No modules.

This module is part of the Philips Forest.

```

```plain
___ _
/ __\__ _ __ ___ ___| |_
/ _\/ _ \| '__/ _ \/ __| __|
/ / | (_) | | | __/\__ \ |_
\/ \___/|_| \___||___/\__|

Infrastructure

```

Talk to the forestkeepers in the `forest`-channel on Slack.
Expand Down
4 changes: 1 addition & 3 deletions modules/webhook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,14 @@ No modules.

This module is part of the Philips Forest.

```

```plain
___ _
/ __\__ _ __ ___ ___| |_
/ _\/ _ \| '__/ _ \/ __| __|
/ / | (_) | | | __/\__ \ |_
\/ \___/|_| \___||___/\__|

Infrastructure

```

Talk to the forestkeepers in the `forest`-channel on Slack.
Expand Down