Skip to content

Commit 223edfc

Browse files
DeeKay3cbartz
andauthored
Feat/isd 3149/adding how to landing page (#536)
* feat/ISD-3149: Adding the initial how-to landing page. It's still yet to be properly organized * feat/ISD-3149: Changing the organization of the how-to landing page, fix ordering of index.md accordingly * Update docs/changelog.md --------- Co-authored-by: Christopher Bartz <[email protected]>
1 parent 0c16d87 commit 223edfc

File tree

3 files changed

+41
-4
lines changed

3 files changed

+41
-4
lines changed

docs/changelog.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Changelog
22

3-
### 20250-04-15
3+
### 2025-04-22
4+
5+
- Add how-to landing page.
6+
7+
### 2025-04-15
48

59
- Fix a race condition where keypairs were being deleted even though the server was being built, potentially killing active github action runs.
610

docs/how-to/index.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# How-to guides
2+
3+
The following guides cover key processes and common tasks for managing
4+
and using the Github Runner charm.
5+
6+
## Initial setup
7+
* [Change repository or organization]
8+
* [Change GitHub personal access token]
9+
10+
## Basic operations
11+
* [Add custom labels]
12+
* [Debug with SSH]
13+
* [Integrate with COS]
14+
* [Spawn OpenStack runner]
15+
* [Set up reactive spawning]
16+
17+
## Security
18+
* [Comply with security requirements]
19+
20+
## Development
21+
* [Contribute]
22+
23+
<!--Links-->
24+
25+
[Change repository or organization]: (how-to/change-path.md)
26+
[Change GitHub personal access token]: (how-to/change-token.md)
27+
[Add custom labels]: (how-to/add-custom-labels.md)
28+
[Debug with SSH]: (how-to/debug-with-ssh.md)
29+
[Integrate with COS]: (how-to/integrate-with-cos.md)
30+
[Spawn OpenStack runner]: (how-to/openstack-runner.md)
31+
[Set up reactive spawning]: (how-to/reactive.md)
32+
[Comply with security requirements]: (how-to/comply-security.md)
33+
[Contribute]: (how-to/contribute.md)

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ Thinking about using the GitHub runner charm for your next project? [Get in touc
4646
# Contents
4747

4848
1. [How to](how-to)
49-
1. [Add custom labels](how-to/add-custom-labels.md)
5049
1. [Change repository or organization](how-to/change-path.md)
5150
1. [Change GitHub personal access token](how-to/change-token.md)
52-
1. [Comply with security requirements](how-to/comply-security.md)
53-
1. [Contribute](how-to/contribute.md)
51+
1. [Add custom labels](how-to/add-custom-labels.md)
5452
1. [Debug with SSH](how-to/debug-with-ssh.md)
5553
1. [Integrate with COS](how-to/integrate-with-cos.md)
5654
1. [Spawn OpenStack runner](how-to/openstack-runner.md)
5755
1. [Set up reactive spawning](how-to/reactive.md)
56+
1. [Comply with security requirements](how-to/comply-security.md)
57+
1. [Contribute](how-to/contribute.md)
5858
1. [Reference](reference)
5959
1. [Actions](reference/actions.md)
6060
1. [Configurations](reference/configurations.md)

0 commit comments

Comments
 (0)