From 1d03e620cf64e163bcefed7a30e78ba3d11c7ea3 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 16:06:49 -0400 Subject: [PATCH] Code infra handbook section --- docs/handbook/infrastructure/.nav.yml | 4 +++- docs/handbook/infrastructure/code/.nav.yml | 5 +++++ docs/handbook/infrastructure/code/forgejo.md | 14 ++++++++++++++ docs/handbook/infrastructure/code/index.md | 11 +++++++++++ docs/handbook/infrastructure/code/mirroring.md | 7 +++++++ 5 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 docs/handbook/infrastructure/code/.nav.yml create mode 100644 docs/handbook/infrastructure/code/forgejo.md create mode 100644 docs/handbook/infrastructure/code/index.md create mode 100644 docs/handbook/infrastructure/code/mirroring.md diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml index 3c5383d..f9748ff 100644 --- a/docs/handbook/infrastructure/.nav.yml +++ b/docs/handbook/infrastructure/.nav.yml @@ -6,5 +6,7 @@ nav: - storage - communication - monitoring + - code - runbooks.md - - naming_conventions.md \ No newline at end of file + - naming_conventions.md + - file_locations.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/code/.nav.yml b/docs/handbook/infrastructure/code/.nav.yml new file mode 100644 index 0000000..7890f6b --- /dev/null +++ b/docs/handbook/infrastructure/code/.nav.yml @@ -0,0 +1,5 @@ +title: Code +nav: + - index.md + - forgejo.md + - mirroring.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/code/forgejo.md b/docs/handbook/infrastructure/code/forgejo.md new file mode 100644 index 0000000..23ae221 --- /dev/null +++ b/docs/handbook/infrastructure/code/forgejo.md @@ -0,0 +1,14 @@ +# Forgejo + +We use a self-hosted Forgejo instance for our Git source code hosting. + +**URL**: [:simple-forgejo: git.starcat.systems](https://git.starcat.systems) +**Homepage**: [:octicons-link-external-16: forgejo.org](https://forgejo.org/) +**Hosting**: [:octicons-arrow-right-16: Hetzner](../servers_and_hosting/hetzner.md) `HEL` + +--- + +!!! example "Work in Progress" + This page is not complete, and is subject to change. + + Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/code/index.md b/docs/handbook/infrastructure/code/index.md new file mode 100644 index 0000000..d2d6399 --- /dev/null +++ b/docs/handbook/infrastructure/code/index.md @@ -0,0 +1,11 @@ +# Code + +!!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + +--- + +!!! example "Work in Progress" + This page is not complete, and is subject to change. + + Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/code/mirroring.md b/docs/handbook/infrastructure/code/mirroring.md new file mode 100644 index 0000000..8dfc1af --- /dev/null +++ b/docs/handbook/infrastructure/code/mirroring.md @@ -0,0 +1,7 @@ +# Code Mirroring +You may notice that some of our Git repos (including the repo with the source for this site) have badges showing that they are mirrored to other Git hosts, such as Sourcehut and GitLab. Why are we mirroring some (but not necessarily all) of our repos? + +## Why? +The short version of *Why?* is that if something breaks, we want to have all the materials we need to fix it quickly. This site, our internal handbook, and our infrastructure repos contain notes, documentation, runbooks, and other helpful files and information about how our infrastructure, apps, and business as a whole are set up. + +The easier and faster we can get to all of this information, the easier and faster we can get everything back up and running. \ No newline at end of file