Skip to content

Commit 302d2e3

Browse files
npalmstuartp44
andauthored
docs: explicit naming submodules (#4175)
## Description Make explicit what is the main and what is a submodule. <img width="1011" alt="image" src="https://github.com/user-attachments/assets/7f3876eb-8401-4bfe-a7b6-cf42f88dac5e"> --------- Co-authored-by: Stuart Pearson <[email protected]>
1 parent 2302e48 commit 302d2e3

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

docs/modules/runners.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
1-
# Runner module (root)
1+
# Runner module (main)
2+
3+
!!! note
4+
This is the top-level module located in the root of the repository. The directory [`modules/runners`](../internal/runners/) contains an internal Terraform sub-module used by this and the [mult-runner module](../public/multi-runner/)
25

36
This module creates resources in your AWS infrastructure, and EC2 instances for hosting the self-hosted runners on-demand. IAM permissions are set to a minimal level, and could be further limited by using permission boundaries. Instances permissions are limited to retrieve and delete the registration token, access the instance's own tags, and terminate the instance itself. By nature instances are short-lived, we strongly suggest to use ephemeral runners to ensure a safe build environment for each workflow job execution.
47

8+
Example usages:
9+
10+
- [Basic example](../../examples/default/)
11+
- [Ephemeral example](../../examples/ephemeral/)
12+
513
--8<-- "README.md:mkdocsrunners"

mkdocs.yaml

+7-6
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,13 @@ nav:
5353
- Getting started: getting-started.md
5454
- Security: security.md
5555
- Modules:
56-
- Runners (root): modules/runners.md
57-
- Multi Runners: modules/public/multi-runner.md
58-
- AMI Housekeeper: modules/public/ami-housekeeper.md
59-
- Lambda Downloader: modules/public/download-lambda.md
60-
- Setup IAM permissions: modules/public/setup-iam-permissions.md
61-
- Internal:
56+
- Runners (main): modules/runners.md
57+
- Submodules (public):
58+
- Multi Runners: modules/public/multi-runner.md
59+
- AMI Housekeeper: modules/public/ami-housekeeper.md
60+
- Lambda Downloader: modules/public/download-lambda.md
61+
- Setup IAM permissions: modules/public/setup-iam-permissions.md
62+
- Submodules (internal):
6263
- Runners: modules/internal/runners.md
6364
- Syncer: modules/internal/runner-binaries-syncer.md
6465
- SSM: modules/internal/ssm.md

0 commit comments

Comments
 (0)