Skip to content

Commit 1ae07bf

Browse files
committed
add anchors to readme
Signed-off-by: Tim Etchells <[email protected]>
1 parent 6d9970c commit 1ae07bf

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Diff for: README.md

+5
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ You must have `helm` v3 and either `oc` or `kubectl` installed. You can use the
3030

3131
You do **not** need cluster administrator privileges to deploy the runners and run workloads. However, some images or tools may require special permissions.
3232

33+
<a id="example-workflows"></a>
34+
3335
## Example Workflows
3436
Refer to the [**Repository Example**](./.github/workflows/repo_example.yml) and [**Organization Example**](./.github/workflows/org_example.yml). The Repository example is also an example of using a [`repository_dispatch` event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#repository_dispatch) to trigger a separate workflow, once the runner is ready.
3537

@@ -66,6 +68,8 @@ jobs:
6668
# ... etc
6769
```
6870

71+
<a id="inputs"></a>
72+
6973
## Inputs
7074
The only required input is the `github_pat`, which is a [Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token), with the appropriate permisions.
7175

@@ -101,6 +105,7 @@ You can use the `helm_release_name` output to determine the helm release name to
101105

102106
Refer to the [tear down example](./.github/workflows/tear_down_runners.yml) and the [organization workflow](./.github/workflows/org_example.yml) for examples.
103107

108+
<a id="troubleshooting"></a>
104109
## Troubleshooting
105110

106111
See the Troubleshooting sections of [the chart README](https://github.com/redhat-actions/openshift-actions-runner-chart#Troubleshooting), and [the runner README](https://github.com/redhat-actions/openshift-actions-runner#Troubleshooting).

0 commit comments

Comments
 (0)