[Docs] Move into [docs] folder and other minor fixes (#1769)
* [Docs] Move into docs folder and other minor fixes * Move into [docs] folder * Fix minor formatting * Create detailed-docs.md Moving current Readme contents into a separate detailed-docs.md file. Added one additional section "Getting Started" to have the getting started link. Rest of the file is as is from the current Readme.md This file would be linked from a new simplified Readme (to be raised a separate PR)
This commit is contained in:
parent
e4fd4bc99c
commit
71da6d5271
|
|
@ -1,7 +1,7 @@
|
||||||
## Introduction
|
## Introduction
|
||||||
This document provides a high level overview of Actions Runner Controller (ARC). ARC enables running Github Actions Runners on Kubernetes (K8s) clusters.
|
This document provides a high-level overview of Actions Runner Controller (ARC). ARC enables running Github Actions Runners on Kubernetes (K8s) clusters.
|
||||||
|
|
||||||
This document provides a background of Github Actions, self-hosted runners and ARC overview. By the end of the doc, the reader should have a foundation with basic scenarios and be capable of reviewing other advanced topics.
|
With this overview, you can get a foundation of basic scenarios and be capable of reviewing other advanced topics.
|
||||||
|
|
||||||
## GitHub Actions
|
## GitHub Actions
|
||||||
[GitHub Actions](https://github.com/features/actions) is a continuous integration and continuous delivery (CI/CD) platform to automate your build, test, and deployment pipeline.
|
[GitHub Actions](https://github.com/features/actions) is a continuous integration and continuous delivery (CI/CD) platform to automate your build, test, and deployment pipeline.
|
||||||
|
|
@ -15,9 +15,7 @@ In this guide, we will setup prerequistes, deploy Actions Runner controller (ARC
|
||||||
|
|
||||||
<details><summary><sub>Create a K8s cluster, if not available.</sub></summary>
|
<details><summary><sub>Create a K8s cluster, if not available.</sub></summary>
|
||||||
<sub>
|
<sub>
|
||||||
If you don't have a K8s cluster, you can install a local environment using minikube. For more information, see "[Installing minikube](https://minikube.sigs.k8s.io/docs/start/)."
|
If you don't have a K8s cluster, you can install a local environment using minikube. For more information, see <a href="https://minikube.sigs.k8s.io/docs/start/">"Installing minikube."</a>
|
||||||
|
|
||||||
"[Using workflows](/actions/using-workflows)."
|
|
||||||
</sub>
|
</sub>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
@ -33,7 +31,7 @@ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/
|
||||||
|
|
||||||
|
|
||||||
:two: Next, Generate a Personal Access Token (PAT) for ARC to authenticate with GitHub.
|
:two: Next, Generate a Personal Access Token (PAT) for ARC to authenticate with GitHub.
|
||||||
- Login to GitHub account and Navigate to https://github.com/settings/tokens/new.
|
- Login to GitHub account and Navigate to "[Create new Token](https://github.com/settings/tokens/new)."
|
||||||
- Select **repo**.
|
- Select **repo**.
|
||||||
- Click **Generate Token** and then copy the token locally ( we’ll need it later).
|
- Click **Generate Token** and then copy the token locally ( we’ll need it later).
|
||||||
|
|
||||||
|
|
@ -129,7 +127,7 @@ GitHub documentation lists the steps to target Actions against self hosted runne
|
||||||
There's also has a quick start guide to get started on Actions, For more information, see "[Quick start Guide to GitHub Actions](https://docs.github.com/en/actions/quickstart)."
|
There's also has a quick start guide to get started on Actions, For more information, see "[Quick start Guide to GitHub Actions](https://docs.github.com/en/actions/quickstart)."
|
||||||
|
|
||||||
## Next steps
|
## Next steps
|
||||||
ARC provides several interesting features and capabilities. For more information, see "[readme](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/README.md)."
|
ARC provides several interesting features and capabilities. For more information, see "[Readme](https://github.com/actions-runner-controller/actions-runner-controller/blob/master/README.md)."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue