Merge pull request #247 from gabriel-samfira/add-toc-to-docs

Add TOC
cloudbase · May 10, 2024 · 45d5f15 · 45d5f15
2 parents 76d45ad + f721d74
commit 45d5f15
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/doc/github_credentials.md b/doc/github_credentials.md
@@ -5,12 +5,28 @@ Starting with version `v0.1.5`, GARM saves github endpoints and github credentia
 <!-- TOC -->
 
 - [Configuring github endpoints and credentials](#configuring-github-endpoints-and-credentials)
+    - [Create GitHub endpoint](#create-github-endpoint)
     - [Listing GitHub endpoints](#listing-github-endpoints)
     - [Adding GitHub credentials](#adding-github-credentials)
     - [Listing GitHub credentials](#listing-github-credentials)
     - [Deleting GitHub credentials](#deleting-github-credentials)
 
 <!-- /TOC -->
+
+## Create GitHub endpoint
+
+To create a new GitHub endpoint, you can use the following command:
+
+```bash
+garm-cli github endpoint create \
+    --name example \
+    --description "Just an example ghes endpoint" \
+    --base-url https://ghes.example.com \
+    --upload-url https://upload.ghes.example.com \
+    --api-base-url https://api.ghes.example.com \
+    --ca-cert-path $HOME/ca-cert.pem
+```
+
 ## Listing GitHub endpoints
 
 To list the available GitHub endpoints, you can use the following command:

diff --git a/doc/quickstart.md b/doc/quickstart.md
@@ -1,5 +1,24 @@
 # Quick start
 
+<!-- TOC -->
+
+- [Quick start](#quick-start)
+    - [The GitHub PAT Personal Access Token](#the-github-pat-personal-access-token)
+    - [Create the config folder](#create-the-config-folder)
+    - [The config file](#the-config-file)
+    - [The provider section](#the-provider-section)
+    - [Starting the service](#starting-the-service)
+        - [Using Docker](#using-docker)
+        - [Setting up GARM as a system service](#setting-up-garm-as-a-system-service)
+    - [Setting up the webhook](#setting-up-the-webhook)
+    - [Initializing GARM](#initializing-garm)
+    - [Creating a gitHub endpoint Optional](#creating-a-github-endpoint-optional)
+    - [Adding credentials](#adding-credentials)
+    - [Define a repo](#define-a-repo)
+    - [Create a pool](#create-a-pool)
+
+<!-- /TOC -->
+
 Okay, I lied. It's not that quick. But it's not that long either. I promise.
 
 In this guide I'm going to take you through the entire process of setting up garm from scratch. This will include editing the config file (which will probably take the longest amount of time), fetching a proper [PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) (personal access token) from GitHub, setting up the webhooks endpoint, defining your repo/org/enterprise and finally setting up a runner pool.