From 8190d246911082e85fa71eb1ef354eab5b2d885c Mon Sep 17 00:00:00 2001
From: Nabil Freij <nabil.freij@gmail.com>
Date: Tue, 20 Aug 2024 10:10:43 -0700
Subject: [PATCH] Base setup for a CI/CD guide

---
 .pre-commit-config.yaml              |  2 +-
 README.md                            |  3 ++-
 docs/ci_cd_guide/getting_started.rst |  3 +++
 docs/ci_cd_guide/index.rst           | 14 ++++++++++++++
 docs/index.rst                       |  1 +
 5 files changed, 21 insertions(+), 2 deletions(-)
 create mode 100644 docs/ci_cd_guide/getting_started.rst
 create mode 100644 docs/ci_cd_guide/index.rst

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 97e90ef..48bf099 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -15,7 +15,7 @@ repos:
             "--remove-unused-variable",
           ]
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.5.6"
+    rev: "v0.6.1"
     hooks:
       - id: ruff
         args: ["--fix"]
diff --git a/README.md b/README.md
index c8d3a40..cd915c8 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,8 @@ This repository contains information regarding the NumFOCUS infrastructure.
 
 Main sections:
 
-- [Review Process](https://numfocus.github.io/infrastructure/review_process.html): Information regarding the process for projects to ask for infrastructure and what to expect from the review process
+- [Review Process](https://numfocus.github.io/infrastructure/review_process.html): Information regarding the process for projects to ask for infrastructure requests and what to expect from the review process
+- [CI/CD Guide](https://numfocus.github.io/infrastructure/ci_cd_guide/index.html): Information regarding getting CI/CD paid for with NumFOCUS funds.
 - [Projects](https://numfocus.github.io/infrastructure/projects/index.html): Information regarding NumFOCUS projects that use shared infrastructure
 - [Vendors](https://numfocus.github.io/infrastructure/vendors/index.html): Information about NumFOCUS infrastructure providers (e.g., hosting companies)
 
diff --git a/docs/ci_cd_guide/getting_started.rst b/docs/ci_cd_guide/getting_started.rst
new file mode 100644
index 0000000..41173f4
--- /dev/null
+++ b/docs/ci_cd_guide/getting_started.rst
@@ -0,0 +1,3 @@
+***************
+Getting Started
+***************
diff --git a/docs/ci_cd_guide/index.rst b/docs/ci_cd_guide/index.rst
new file mode 100644
index 0000000..f761284
--- /dev/null
+++ b/docs/ci_cd_guide/index.rst
@@ -0,0 +1,14 @@
+******************************
+Paying for CI/CD with numFOCUS
+******************************
+
+This guide is intended to help you set up a CI/CD pipeline for your project and get it paid for by numFOCUS.
+
+**WIP**
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents
+   :glob:
+
+   *
diff --git a/docs/index.rst b/docs/index.rst
index f4132ca..d7ecee3 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,5 +9,6 @@ numFOCUS Project Infrastructure
    charter
    meeting_notes/index
    review_process
+   ci_cd_guide/index
    projects/index
    vendors/index