Skip to content

Commit b0c279c

Browse files
authored
docs: improvement of formatting in documentation (#2290)
* docs: improve code block highlighting in docs * docs: bump download-lambda example to latest release * docs: change code block formatting of logo to plain
1 parent c6275f9 commit b0c279c

File tree

8 files changed

+15
-30
lines changed

8 files changed

+15
-30
lines changed

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Next create a second terraform workspace and initiate the module, or adapt one o
156156

157157
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.
158158

159-
```terraform
159+
```hcl
160160
module "github-runner" {
161161
source = "philips-labs/github-runner/aws"
162162
version = "REPLACE_WITH_VERSION"
@@ -244,7 +244,6 @@ module "runners" {
244244
...
245245
kms_key_arn = aws_kms_key.github.arn
246246
...
247-
248247
```
249248

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

507506
This module is part of the Philips Forest.
508507

509-
```bash
510-
508+
```plain
511509
___ _
512510
/ __\__ _ __ ___ ___| |_
513511
/ _\/ _ \| '__/ _ \/ __| __|
514512
/ / | (_) | | | __/\__ \ |_
515513
\/ \___/|_| \___||___/\__|
516514
517515
Infrastructure
518-
519516
```
520517

521518
Talk to the forestkeepers in the `runners`-channel on Slack.

docs/test-lambda-local.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ output "development" {
3838
value = {
3939
lambda_syncer = module.runners.binaries_syncer.lambda
4040
}
41-
}```
41+
}
42+
```
4243

4344
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.
4445

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

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

63-
```
64+
```bash
6465
export AWS_REGION=<region>
6566
export AWS_PROFILE=gh-development
6667
```
@@ -75,7 +76,6 @@ Instead of using SAM you can use Node with `ts-node-dev` to test the code locall
7576
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.
7677

7778
```bash
78-
7979
role=$(aws sts assume-role \
8080
--role-arn "<ROLE>" \
8181
--duration-seconds 3600 --role-session-name "dev")

examples/prebuilt/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ To use your image in the terraform modules you will need to set some values on t
5252
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.
5353

5454
```hcl
55-
5655
module "runners" {
5756
...
5857
# set the name of the ami to use

modules/download-lambda/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ This module is optional and provides an option to download via Terraform the Lam
44

55
## Usages
66

7-
```
7+
```hcl
88
module "lambdas" {
99
source = "<source location>"
1010
lambdas = [
1111
{
1212
name = "webhook"
13-
tag = "v0.11.0"
13+
tag = "v0.15.0"
1414
},
1515
{
1616
name = "runners"
17-
tag = "v0.11.0"
17+
tag = "v0.15.0"
1818
},
1919
{
2020
name = "runner-binaries-syncer"
21-
tag = "v0.11.0"
21+
tag = "v0.15.0"
2222
}
2323
]
2424
}
@@ -65,16 +65,14 @@ No modules.
6565

6666
This module is part of the Philips Forest.
6767

68-
```
69-
68+
```plain
7069
___ _
7170
/ __\__ _ __ ___ ___| |_
7271
/ _\/ _ \| '__/ _ \/ __| __|
7372
/ / | (_) | | | __/\__ \ |_
7473
\/ \___/|_| \___||___/\__|
7574
7675
Infrastructure
77-
7876
```
7977

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

modules/runner-binaries-syncer/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,16 +122,14 @@ No modules.
122122

123123
This module is part of the Philips Forest.
124124

125-
```
126-
125+
```plain
127126
___ _
128127
/ __\__ _ __ ___ ___| |_
129128
/ _\/ _ \| '__/ _ \/ __| __|
130129
/ / | (_) | | | __/\__ \ |_
131130
\/ \___/|_| \___||___/\__|
132131
133132
Infrastructure
134-
135133
```
136134

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

modules/runners/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,16 +209,14 @@ yarn run dist
209209

210210
This module is part of the Philips Forest.
211211

212-
```
213-
212+
```plain
214213
___ _
215214
/ __\__ _ __ ___ ___| |_
216215
/ _\/ _ \| '__/ _ \/ __| __|
217216
/ / | (_) | | | __/\__ \ |_
218217
\/ \___/|_| \___||___/\__|
219218
220219
Infrastructure
221-
222220
```
223221

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

modules/setup-iam-permissions/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This module will create an AWS IAM role that is required to use permission bound
99
See below or check out [this example](../../examples/permissions-boundary/README.md)
1010
Create a workspace and add the following terraform code.
1111

12-
```
12+
```hcl
1313
module "iam" {
1414
source = "../../"
1515
@@ -31,7 +31,6 @@ output "role" {
3131
output "boundary" {
3232
value = module.iam.boundary
3333
}
34-
3534
```
3635

3736
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.
@@ -87,16 +86,14 @@ No modules.
8786

8887
This module is part of the Philips Forest.
8988

90-
```
91-
89+
```plain
9290
___ _
9391
/ __\__ _ __ ___ ___| |_
9492
/ _\/ _ \| '__/ _ \/ __| __|
9593
/ / | (_) | | | __/\__ \ |_
9694
\/ \___/|_| \___||___/\__|
9795
9896
Infrastructure
99-
10097
```
10198

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

modules/webhook/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,16 +113,14 @@ No modules.
113113

114114
This module is part of the Philips Forest.
115115

116-
```
117-
116+
```plain
118117
___ _
119118
/ __\__ _ __ ___ ___| |_
120119
/ _\/ _ \| '__/ _ \/ __| __|
121120
/ / | (_) | | | __/\__ \ |_
122121
\/ \___/|_| \___||___/\__|
123122
124123
Infrastructure
125-
126124
```
127125

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

0 commit comments

Comments
 (0)