From a8a11ffef674047000bdf2fa2a02461402b28339 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 11:16:38 -0400 Subject: [PATCH 01/21] Reorganize folders --- docs/handbook/infrastructure/.nav.yml | 8 +++++--- docs/handbook/infrastructure/apps/.nav.yml | 4 ---- docs/handbook/infrastructure/apps/index.md | 11 ----------- .../{providers => }/communication/.nav.yml | 0 .../{providers => }/communication/index.md | 0 .../{providers => }/communication/mxroute.md | 0 .../{providers => }/communication/voipms.md | 0 .../infrastructure/{apps => }/monitoring/.nav.yml | 0 .../infrastructure/{apps => }/monitoring/beszel.md | 0 .../infrastructure/{apps => }/monitoring/index.md | 0 .../infrastructure/{apps => }/monitoring/uptime.md | 0 .../infrastructure/{providers => }/network/.nav.yml | 0 .../infrastructure/{providers => }/network/bunny.md | 0 .../infrastructure/{providers => }/network/index.md | 0 docs/handbook/infrastructure/providers/.nav.yml | 6 ------ docs/handbook/infrastructure/providers/index.md | 11 ----------- .../{providers => }/servers_and_hosting/.nav.yml | 0 .../{providers => }/servers_and_hosting/hetzner.md | 0 .../{providers => }/servers_and_hosting/index.md | 0 .../{providers => }/servers_and_hosting/nfsn.md | 0 .../{providers => }/servers_and_hosting/pikapods.md | 0 21 files changed, 5 insertions(+), 35 deletions(-) delete mode 100644 docs/handbook/infrastructure/apps/.nav.yml delete mode 100644 docs/handbook/infrastructure/apps/index.md rename docs/handbook/infrastructure/{providers => }/communication/.nav.yml (100%) rename docs/handbook/infrastructure/{providers => }/communication/index.md (100%) rename docs/handbook/infrastructure/{providers => }/communication/mxroute.md (100%) rename docs/handbook/infrastructure/{providers => }/communication/voipms.md (100%) rename docs/handbook/infrastructure/{apps => }/monitoring/.nav.yml (100%) rename docs/handbook/infrastructure/{apps => }/monitoring/beszel.md (100%) rename docs/handbook/infrastructure/{apps => }/monitoring/index.md (100%) rename docs/handbook/infrastructure/{apps => }/monitoring/uptime.md (100%) rename docs/handbook/infrastructure/{providers => }/network/.nav.yml (100%) rename docs/handbook/infrastructure/{providers => }/network/bunny.md (100%) rename docs/handbook/infrastructure/{providers => }/network/index.md (100%) delete mode 100644 docs/handbook/infrastructure/providers/.nav.yml delete mode 100644 docs/handbook/infrastructure/providers/index.md rename docs/handbook/infrastructure/{providers => }/servers_and_hosting/.nav.yml (100%) rename docs/handbook/infrastructure/{providers => }/servers_and_hosting/hetzner.md (100%) rename docs/handbook/infrastructure/{providers => }/servers_and_hosting/index.md (100%) rename docs/handbook/infrastructure/{providers => }/servers_and_hosting/nfsn.md (100%) rename docs/handbook/infrastructure/{providers => }/servers_and_hosting/pikapods.md (100%) diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml index cfbf1f1..0b03573 100644 --- a/docs/handbook/infrastructure/.nav.yml +++ b/docs/handbook/infrastructure/.nav.yml @@ -1,6 +1,8 @@ -title: Infrastructure +title: Apps + Infrastructure nav: - index.md - - apps - - providers + - servers_and_hosting + - network + - communication + - monitoring - naming_conventions.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/apps/.nav.yml b/docs/handbook/infrastructure/apps/.nav.yml deleted file mode 100644 index 1e599be..0000000 --- a/docs/handbook/infrastructure/apps/.nav.yml +++ /dev/null @@ -1,4 +0,0 @@ -title: Apps -nav: - - index.md - - monitoring \ No newline at end of file diff --git a/docs/handbook/infrastructure/apps/index.md b/docs/handbook/infrastructure/apps/index.md deleted file mode 100644 index 88f8079..0000000 --- a/docs/handbook/infrastructure/apps/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Apps - -!!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/communication/.nav.yml b/docs/handbook/infrastructure/communication/.nav.yml similarity index 100% rename from docs/handbook/infrastructure/providers/communication/.nav.yml rename to docs/handbook/infrastructure/communication/.nav.yml diff --git a/docs/handbook/infrastructure/providers/communication/index.md b/docs/handbook/infrastructure/communication/index.md similarity index 100% rename from docs/handbook/infrastructure/providers/communication/index.md rename to docs/handbook/infrastructure/communication/index.md diff --git a/docs/handbook/infrastructure/providers/communication/mxroute.md b/docs/handbook/infrastructure/communication/mxroute.md similarity index 100% rename from docs/handbook/infrastructure/providers/communication/mxroute.md rename to docs/handbook/infrastructure/communication/mxroute.md diff --git a/docs/handbook/infrastructure/providers/communication/voipms.md b/docs/handbook/infrastructure/communication/voipms.md similarity index 100% rename from docs/handbook/infrastructure/providers/communication/voipms.md rename to docs/handbook/infrastructure/communication/voipms.md diff --git a/docs/handbook/infrastructure/apps/monitoring/.nav.yml b/docs/handbook/infrastructure/monitoring/.nav.yml similarity index 100% rename from docs/handbook/infrastructure/apps/monitoring/.nav.yml rename to docs/handbook/infrastructure/monitoring/.nav.yml diff --git a/docs/handbook/infrastructure/apps/monitoring/beszel.md b/docs/handbook/infrastructure/monitoring/beszel.md similarity index 100% rename from docs/handbook/infrastructure/apps/monitoring/beszel.md rename to docs/handbook/infrastructure/monitoring/beszel.md diff --git a/docs/handbook/infrastructure/apps/monitoring/index.md b/docs/handbook/infrastructure/monitoring/index.md similarity index 100% rename from docs/handbook/infrastructure/apps/monitoring/index.md rename to docs/handbook/infrastructure/monitoring/index.md diff --git a/docs/handbook/infrastructure/apps/monitoring/uptime.md b/docs/handbook/infrastructure/monitoring/uptime.md similarity index 100% rename from docs/handbook/infrastructure/apps/monitoring/uptime.md rename to docs/handbook/infrastructure/monitoring/uptime.md diff --git a/docs/handbook/infrastructure/providers/network/.nav.yml b/docs/handbook/infrastructure/network/.nav.yml similarity index 100% rename from docs/handbook/infrastructure/providers/network/.nav.yml rename to docs/handbook/infrastructure/network/.nav.yml diff --git a/docs/handbook/infrastructure/providers/network/bunny.md b/docs/handbook/infrastructure/network/bunny.md similarity index 100% rename from docs/handbook/infrastructure/providers/network/bunny.md rename to docs/handbook/infrastructure/network/bunny.md diff --git a/docs/handbook/infrastructure/providers/network/index.md b/docs/handbook/infrastructure/network/index.md similarity index 100% rename from docs/handbook/infrastructure/providers/network/index.md rename to docs/handbook/infrastructure/network/index.md diff --git a/docs/handbook/infrastructure/providers/.nav.yml b/docs/handbook/infrastructure/providers/.nav.yml deleted file mode 100644 index c2f00e6..0000000 --- a/docs/handbook/infrastructure/providers/.nav.yml +++ /dev/null @@ -1,6 +0,0 @@ -title: Providers -nav: - - index.md - - servers_and_hosting - - network - - communication \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/index.md b/docs/handbook/infrastructure/providers/index.md deleted file mode 100644 index b6686a8..0000000 --- a/docs/handbook/infrastructure/providers/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Infrastructure Providers - -!!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml b/docs/handbook/infrastructure/servers_and_hosting/.nav.yml similarity index 100% rename from docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml rename to docs/handbook/infrastructure/servers_and_hosting/.nav.yml diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/hetzner.md b/docs/handbook/infrastructure/servers_and_hosting/hetzner.md similarity index 100% rename from docs/handbook/infrastructure/providers/servers_and_hosting/hetzner.md rename to docs/handbook/infrastructure/servers_and_hosting/hetzner.md diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/index.md b/docs/handbook/infrastructure/servers_and_hosting/index.md similarity index 100% rename from docs/handbook/infrastructure/providers/servers_and_hosting/index.md rename to docs/handbook/infrastructure/servers_and_hosting/index.md diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md b/docs/handbook/infrastructure/servers_and_hosting/nfsn.md similarity index 100% rename from docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md rename to docs/handbook/infrastructure/servers_and_hosting/nfsn.md diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/pikapods.md b/docs/handbook/infrastructure/servers_and_hosting/pikapods.md similarity index 100% rename from docs/handbook/infrastructure/providers/servers_and_hosting/pikapods.md rename to docs/handbook/infrastructure/servers_and_hosting/pikapods.md -- 2.43.0 From 6763f46c120a31b92d85a8aba21434cce38a75f9 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 11:21:03 -0400 Subject: [PATCH 02/21] Fix links --- docs/handbook/infrastructure/communication/voipms.md | 2 +- docs/handbook/infrastructure/monitoring/beszel.md | 2 +- docs/handbook/infrastructure/monitoring/uptime.md | 2 +- .../handbook/infrastructure/servers_and_hosting/pikapods.md | 6 +++--- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/handbook/infrastructure/communication/voipms.md b/docs/handbook/infrastructure/communication/voipms.md index 800af69..c34c714 100644 --- a/docs/handbook/infrastructure/communication/voipms.md +++ b/docs/handbook/infrastructure/communication/voipms.md @@ -20,4 +20,4 @@ If you need to set or change your voicemail message for your direct line voicema !!! 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-24: Editing this site](../../../meta/editing.md) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/monitoring/beszel.md b/docs/handbook/infrastructure/monitoring/beszel.md index 76af88f..455fad0 100644 --- a/docs/handbook/infrastructure/monitoring/beszel.md +++ b/docs/handbook/infrastructure/monitoring/beszel.md @@ -4,7 +4,7 @@ Simple, lightweight server monitoring **URL**: [:octicons-tab-external-16: beszel.starcatsys.net](https://beszel.starcatsys.net) **Homepage**: [:octicons-link-external-24: beszel.dev](https://beszel.dev/) -**Hosting**: [:octicons-arrow-right-24: PikaPods](../../providers/servers_and_hosting/pikapods.md) `EU` +**Hosting**: [:octicons-arrow-right-24: PikaPods](../servers_and_hosting/pikapods.md) `EU` --- diff --git a/docs/handbook/infrastructure/monitoring/uptime.md b/docs/handbook/infrastructure/monitoring/uptime.md index 980d4e4..33a33fe 100644 --- a/docs/handbook/infrastructure/monitoring/uptime.md +++ b/docs/handbook/infrastructure/monitoring/uptime.md @@ -4,7 +4,7 @@ Uptime Kuma is an easy-to-use self-hosted monitoring tool. **URL**: [:octicons-tab-external-16: uptime.starcatsys.net](https://uptime.starcatsys.net) **Homepage**: [:octicons-link-external-24: louislam/uptime-kuma - GitHub](https://github.com/louislam/uptime-kuma) -**Hosting**: [:octicons-arrow-right-24: PikaPods](../../providers/servers_and_hosting/pikapods.md) `EU` +**Hosting**: [:octicons-arrow-right-24: PikaPods](../servers_and_hosting/pikapods.md) `EU` diff --git a/docs/handbook/infrastructure/servers_and_hosting/pikapods.md b/docs/handbook/infrastructure/servers_and_hosting/pikapods.md index ce5b8e1..f881462 100644 --- a/docs/handbook/infrastructure/servers_and_hosting/pikapods.md +++ b/docs/handbook/infrastructure/servers_and_hosting/pikapods.md @@ -5,8 +5,8 @@ [:octicons-link-external-24: Control panel](https://www.pikapods.com/pods) - limited access, contact admin if you need access or need to make changes ## Hosted Apps -- [:octicons-arrow-right-24: Beszel](../../apps/monitoring/beszel.md) -- [:octicons-arrow-right-24: Uptime](../../apps/monitoring/uptime.md) +- [:octicons-arrow-right-24: Beszel](../monitoring/beszel.md) +- [:octicons-arrow-right-24: Uptime](../monitoring/uptime.md) ## Regions When it makes sense, host any new pods in the `EU` region, as it places the pod closer to the majority of our services. For our USA hosted services, or in other special situations, pods can also be hosted in the `US` region. @@ -15,4 +15,4 @@ When it makes sense, host any new pods in the `EU` region, as it places the pod !!! 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-24: Editing this site](../../../meta/editing.md) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file -- 2.43.0 From 9b55383ddb61518416c132c72bc2a6fdc5229abb Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 11:28:10 -0400 Subject: [PATCH 03/21] Change all icons to 16px from 24px --- docs/about/index.md | 2 +- docs/contact/index.md | 2 +- docs/docshq/index.md | 2 +- docs/handbook/index.md | 2 +- .../infrastructure/communication/index.md | 2 +- .../infrastructure/communication/mxroute.md | 8 ++++---- .../infrastructure/communication/voipms.md | 6 +++--- docs/handbook/infrastructure/index.md | 2 +- .../handbook/infrastructure/monitoring/beszel.md | 6 +++--- docs/handbook/infrastructure/monitoring/index.md | 2 +- .../handbook/infrastructure/monitoring/uptime.md | 6 +++--- docs/handbook/infrastructure/network/bunny.md | 2 +- docs/handbook/infrastructure/network/index.md | 2 +- .../servers_and_hosting/hetzner.md | 6 +++--- .../infrastructure/servers_and_hosting/index.md | 2 +- .../infrastructure/servers_and_hosting/nfsn.md | 2 +- .../servers_and_hosting/pikapods.md | 10 +++++----- docs/handbook/meta/editing.md | 6 +++--- docs/handbook/meta/index.md | 2 +- docs/index.md | 16 ++++++++-------- docs/policies/index.md | 2 +- docs/postline/index.md | 2 +- docs/sourcecamp/index.md | 2 +- docs/stagelink/index.md | 2 +- 24 files changed, 48 insertions(+), 48 deletions(-) diff --git a/docs/about/index.md b/docs/about/index.md index 5682444..b4a74b8 100644 --- a/docs/about/index.md +++ b/docs/about/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/contact/index.md b/docs/contact/index.md index 9c43bac..7f06ff9 100644 --- a/docs/contact/index.md +++ b/docs/contact/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/docshq/index.md b/docs/docshq/index.md index ff102b8..8f20376 100644 --- a/docs/docshq/index.md +++ b/docs/docshq/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/index.md b/docs/handbook/index.md index dc1db38..acd649c 100644 --- a/docs/handbook/index.md +++ b/docs/handbook/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/communication/index.md b/docs/handbook/infrastructure/communication/index.md index 521767d..7aa2598 100644 --- a/docs/handbook/infrastructure/communication/index.md +++ b/docs/handbook/infrastructure/communication/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/communication/mxroute.md b/docs/handbook/infrastructure/communication/mxroute.md index 3374f7e..4241226 100644 --- a/docs/handbook/infrastructure/communication/mxroute.md +++ b/docs/handbook/infrastructure/communication/mxroute.md @@ -1,6 +1,6 @@ # MXroute -[:octicons-link-external-24: MXroute](https://mxroute.com/) hosts our email servers for coporate email, transactional messages, and Postline groups. +[:octicons-link-external-16: MXroute](https://mxroute.com/) hosts our email servers for coporate email, transactional messages, and Postline groups. ## Servers List of MXroute servers that we use to run our infrastructure: @@ -8,8 +8,8 @@ List of MXroute servers that we use to run our infrastructure: ### `heracles` #### Quick Links -[:octicons-link-external-24: Control panel](https://heracles.mxrouting.net:2222/) - limited access, contact admin if you need access or need to make changes -[:octicons-link-external-24: Basic webmail](https://heracles.mxrouting.net:2222/evo/roundcube) - log in with your full `@starcat.systems` or `@starcatsys.net` email address +[:octicons-link-external-16: Control panel](https://heracles.mxrouting.net:2222/) - limited access, contact admin if you need access or need to make changes +[:octicons-link-external-16: Basic webmail](https://heracles.mxrouting.net:2222/evo/roundcube) - log in with your full `@starcat.systems` or `@starcatsys.net` email address #### Connection Information IMAP Server: `heracles.mxrouting.net` @@ -27,4 +27,4 @@ Please see the [:octicons-lock-16: MXroute](https://git.starcat.systems/starcat- !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/communication/voipms.md b/docs/handbook/infrastructure/communication/voipms.md index c34c714..343a7d9 100644 --- a/docs/handbook/infrastructure/communication/voipms.md +++ b/docs/handbook/infrastructure/communication/voipms.md @@ -1,8 +1,8 @@ # Voip.ms -[:octicons-link-external-24: Voip.ms](https://voip.ms/) provides phone numbers, calls, and text messages for corporate phone, and app communications. +[:octicons-link-external-16: Voip.ms](https://voip.ms/) provides phone numbers, calls, and text messages for corporate phone, and app communications. ## Quick Links -[:octicons-link-external-24: Control panel](https://voip.ms/signin/index.php?ln=en) - limited access, contact admin if you need access or need to make changes +[:octicons-link-external-16: Control panel](https://voip.ms/signin/index.php?ln=en) - limited access, contact admin if you need access or need to make changes ## Current Setup ### Incoming Calls @@ -20,4 +20,4 @@ If you need to set or change your voicemail message for your direct line voicema !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/index.md b/docs/handbook/infrastructure/index.md index 4d4c775..220e945 100644 --- a/docs/handbook/infrastructure/index.md +++ b/docs/handbook/infrastructure/index.md @@ -10,4 +10,4 @@ Various things related to the servers, systems, and services that power all Star !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/monitoring/beszel.md b/docs/handbook/infrastructure/monitoring/beszel.md index 455fad0..281b58f 100644 --- a/docs/handbook/infrastructure/monitoring/beszel.md +++ b/docs/handbook/infrastructure/monitoring/beszel.md @@ -3,12 +3,12 @@ Simple, lightweight server monitoring **URL**: [:octicons-tab-external-16: beszel.starcatsys.net](https://beszel.starcatsys.net) -**Homepage**: [:octicons-link-external-24: beszel.dev](https://beszel.dev/) -**Hosting**: [:octicons-arrow-right-24: PikaPods](../servers_and_hosting/pikapods.md) `EU` +**Homepage**: [:octicons-link-external-16: beszel.dev](https://beszel.dev/) +**Hosting**: [:octicons-arrow-right-16: PikaPods](../servers_and_hosting/pikapods.md) `EU` --- !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/monitoring/index.md b/docs/handbook/infrastructure/monitoring/index.md index 1a27594..0ef711b 100644 --- a/docs/handbook/infrastructure/monitoring/index.md +++ b/docs/handbook/infrastructure/monitoring/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/monitoring/uptime.md b/docs/handbook/infrastructure/monitoring/uptime.md index 33a33fe..b8310a0 100644 --- a/docs/handbook/infrastructure/monitoring/uptime.md +++ b/docs/handbook/infrastructure/monitoring/uptime.md @@ -3,8 +3,8 @@ Uptime Kuma is an easy-to-use self-hosted monitoring tool. **URL**: [:octicons-tab-external-16: uptime.starcatsys.net](https://uptime.starcatsys.net) -**Homepage**: [:octicons-link-external-24: louislam/uptime-kuma - GitHub](https://github.com/louislam/uptime-kuma) -**Hosting**: [:octicons-arrow-right-24: PikaPods](../servers_and_hosting/pikapods.md) `EU` +**Homepage**: [:octicons-link-external-16: louislam/uptime-kuma - GitHub](https://github.com/louislam/uptime-kuma) +**Hosting**: [:octicons-arrow-right-16: PikaPods](../servers_and_hosting/pikapods.md) `EU` @@ -13,4 +13,4 @@ Uptime Kuma is an easy-to-use self-hosted monitoring tool. !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/network/bunny.md b/docs/handbook/infrastructure/network/bunny.md index 60d897d..d0cfbfe 100644 --- a/docs/handbook/infrastructure/network/bunny.md +++ b/docs/handbook/infrastructure/network/bunny.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/network/index.md b/docs/handbook/infrastructure/network/index.md index c17e3ec..f0af8fe 100644 --- a/docs/handbook/infrastructure/network/index.md +++ b/docs/handbook/infrastructure/network/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/servers_and_hosting/hetzner.md b/docs/handbook/infrastructure/servers_and_hosting/hetzner.md index 8b5d2ec..29d87c0 100644 --- a/docs/handbook/infrastructure/servers_and_hosting/hetzner.md +++ b/docs/handbook/infrastructure/servers_and_hosting/hetzner.md @@ -3,9 +3,9 @@ [:simple-hetzner: Hetzner](https://www.hetzner.com/) hosts the majority of our servers, both virtual and physical. ## Quick Links -[:octicons-link-external-24: Cloud console login](https://console.hetzner.cloud/) - VPS management -[:octicons-link-external-24: Robot console login](https://robot.hetzner.com/) - dedicated server management -[:octicons-link-external-24: Billing console login](https://accounts.hetzner.com/invoice) - billing and invoice information +[:octicons-link-external-16: Cloud console login](https://console.hetzner.cloud/) - VPS management +[:octicons-link-external-16: Robot console login](https://robot.hetzner.com/) - dedicated server management +[:octicons-link-external-16: Billing console login](https://accounts.hetzner.com/invoice) - billing and invoice information ## Server Types **VPS**: Typically we use `CAX` series servers when we can use an ARM processor. If we need an x86 processor, we usually use `CX` or `CPX` servies servers. diff --git a/docs/handbook/infrastructure/servers_and_hosting/index.md b/docs/handbook/infrastructure/servers_and_hosting/index.md index 5d4bde8..7885d3a 100644 --- a/docs/handbook/infrastructure/servers_and_hosting/index.md +++ b/docs/handbook/infrastructure/servers_and_hosting/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/servers_and_hosting/nfsn.md b/docs/handbook/infrastructure/servers_and_hosting/nfsn.md index bc99308..6846073 100644 --- a/docs/handbook/infrastructure/servers_and_hosting/nfsn.md +++ b/docs/handbook/infrastructure/servers_and_hosting/nfsn.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/servers_and_hosting/pikapods.md b/docs/handbook/infrastructure/servers_and_hosting/pikapods.md index f881462..f4957f1 100644 --- a/docs/handbook/infrastructure/servers_and_hosting/pikapods.md +++ b/docs/handbook/infrastructure/servers_and_hosting/pikapods.md @@ -1,12 +1,12 @@ # PikaPods -[:octicons-link-external-24: PikaPods](https://pikapods.com/) is an open source app hosting provider that we use to host some of our internal apps. +[:octicons-link-external-16: PikaPods](https://pikapods.com/) is an open source app hosting provider that we use to host some of our internal apps. ## Quick Links -[:octicons-link-external-24: Control panel](https://www.pikapods.com/pods) - limited access, contact admin if you need access or need to make changes +[:octicons-link-external-16: Control panel](https://www.pikapods.com/pods) - limited access, contact admin if you need access or need to make changes ## Hosted Apps -- [:octicons-arrow-right-24: Beszel](../monitoring/beszel.md) -- [:octicons-arrow-right-24: Uptime](../monitoring/uptime.md) +- [:octicons-arrow-right-16: Beszel](../monitoring/beszel.md) +- [:octicons-arrow-right-16: Uptime](../monitoring/uptime.md) ## Regions When it makes sense, host any new pods in the `EU` region, as it places the pod closer to the majority of our services. For our USA hosted services, or in other special situations, pods can also be hosted in the `US` region. @@ -15,4 +15,4 @@ When it makes sense, host any new pods in the `EU` region, as it places the pod !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index aba6bf1..3be5e9c 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -2,9 +2,9 @@ ## Icons Commonly-used icons for links: -:octicons-arrow-right-24: `:octicons-arrow-right-24:` - used for links within the wiki +:octicons-arrow-right-16: `:octicons-arrow-right-16:` - used for links within the wiki :octicons-tab-external-16: `:octicons-tab-external-16:` - used for links outside the wiki, but within StarCat Systems -:octicons-link-external-24: `:octicons-link-external-24:` - used for external links to sites not controlled by StarCat Systems +:octicons-link-external-16: `:octicons-link-external-16:` - used for external links to sites not controlled by StarCat Systems --- @@ -12,4 +12,4 @@ Commonly-used icons for links: !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/handbook/meta/index.md b/docs/handbook/meta/index.md index b18a25e..38c8ff4 100644 --- a/docs/handbook/meta/index.md +++ b/docs/handbook/meta/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 1d570e8..2adcd57 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,7 +29,7 @@ You'll find the following sections of information on this site: Information about [StarCat Systems](https://starcat.systems) and our projects, as a whole. - [:octicons-arrow-right-24: About](about/index.md) + [:octicons-arrow-right-16: About](about/index.md) - :material-tent:{ .lg .middle } **SourceCamp** @@ -37,7 +37,7 @@ You'll find the following sections of information on this site: Information about [SourceCamp](https://starcat.systems), a simple, private Git server host. - [:octicons-arrow-right-24: SourceCamp](sourcecamp/index.md) + [:octicons-arrow-right-16: SourceCamp](sourcecamp/index.md) - :material-notebook-outline:{ .lg .middle } **DocsHQ** @@ -45,7 +45,7 @@ You'll find the following sections of information on this site: Information about [DocsHQ](https://docshq.app), a continuous documentation platform. - [:octicons-arrow-right-24: DocsHQ](docshq/index.md) + [:octicons-arrow-right-16: DocsHQ](docshq/index.md) - :material-email-fast-outline:{ .lg .middle } **Postline** @@ -53,7 +53,7 @@ You'll find the following sections of information on this site: Information about [Postline](https://postline.email), a discussion + announcement list service. - [:octicons-arrow-right-24: Postline](postline/index.md) + [:octicons-arrow-right-16: Postline](postline/index.md) - :octicons-sliders-16:{ .lg .middle } **StageLink** @@ -61,7 +61,7 @@ You'll find the following sections of information on this site: Information about [StageLink](https://stagelink.cloud), a remote AV+ system management platform. - [:octicons-arrow-right-24: StageLink](stagelink/index.md) + [:octicons-arrow-right-16: StageLink](stagelink/index.md) - :fontawesome-solid-scroll:{ .lg .middle } **Policies** @@ -69,7 +69,7 @@ You'll find the following sections of information on this site: The policies and terms you agree to when you use any of our projects. - [:octicons-arrow-right-24: Policies](policies/index.md) + [:octicons-arrow-right-16: Policies](policies/index.md) - :material-book:{ .lg .middle } **Handbook** @@ -77,12 +77,12 @@ You'll find the following sections of information on this site: Documentation and notes about the running of our projects. Take a look behind the scenes! - [:octicons-arrow-right-24: Handbook](handbook/index.md) + [:octicons-arrow-right-16: Handbook](handbook/index.md) ## :octicons-pencil-24: Edit this site -Found an error, or have a content suggestion? **You** are welcome to suggest changes to this site! The source material for this site is hosted on our [:simple-forgejo: Git server](https://git.starcat.systems/starcatsys/about_docs). Check out the [:octicons-arrow-right-24: Editing this site](editing.md) section in the Handbook for more information on making changes. +Found an error, or have a content suggestion? **You** are welcome to suggest changes to this site! The source material for this site is hosted on our [:simple-forgejo: Git server](https://git.starcat.systems/starcatsys/about_docs). Check out the [:octicons-arrow-right-16: Editing this site](editing.md) section in the Handbook for more information on making changes. ## :fontawesome-brands-creative-commons: License The contents of this site are licensed under [:fontawesome-brands-creative-commons::fontawesome-brands-creative-commons-by::fontawesome-brands-creative-commons-sa: CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), unless otherwise noted. \ No newline at end of file diff --git a/docs/policies/index.md b/docs/policies/index.md index de213c5..971f439 100644 --- a/docs/policies/index.md +++ b/docs/policies/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/postline/index.md b/docs/postline/index.md index 908d316..60d613d 100644 --- a/docs/postline/index.md +++ b/docs/postline/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/sourcecamp/index.md b/docs/sourcecamp/index.md index 64c35ef..272f131 100644 --- a/docs/sourcecamp/index.md +++ b/docs/sourcecamp/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file diff --git a/docs/stagelink/index.md b/docs/stagelink/index.md index 607f3c3..884631b 100644 --- a/docs/stagelink/index.md +++ b/docs/stagelink/index.md @@ -8,4 +8,4 @@ !!! 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-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file + 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_docs) for this site. \ No newline at end of file -- 2.43.0 From 1d63898d0cc97985913d4742cb7733f87e47dab9 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 11:34:21 -0400 Subject: [PATCH 04/21] Icons and Material MkDocs references --- docs/handbook/meta/editing.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index 3be5e9c..919fbc9 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -1,7 +1,14 @@ # Editing this site +This page contains information on editing/making changes to this website. + +## Material for MkDocs +This site is written in Markdown and is generated using [:simple-materialformkdocs: Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) Insiders. The source Markdown is stored in the [:simple-forgejo: about_docs Git repo](https://git.starcat.systems/starcatsys/about_docs). + ## Icons -Commonly-used icons for links: +Reference for all available Material for MkDocs icons: [:simple-materialformkdocs: Icons, Emojis](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/) + +### Commonly-used icons for links: :octicons-arrow-right-16: `:octicons-arrow-right-16:` - used for links within the wiki :octicons-tab-external-16: `:octicons-tab-external-16:` - used for links outside the wiki, but within StarCat Systems :octicons-link-external-16: `:octicons-link-external-16:` - used for external links to sites not controlled by StarCat Systems -- 2.43.0 From fc709ae7b9a1cdd0a4e322c16316a20ac12c92eb Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 12:13:16 -0400 Subject: [PATCH 05/21] Icon colors match admonitions --- docs/handbook/meta/editing.md | 24 +++++++++++++++++++++++- docs/stylesheets/extra.css | 31 +++++++++++++++++++++++++++++-- mkdocs.yml | 2 +- 3 files changed, 53 insertions(+), 4 deletions(-) diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index 919fbc9..f6051bf 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -8,11 +8,33 @@ This site is written in Markdown and is generated using [:simple-materialformkdo ## Icons Reference for all available Material for MkDocs icons: [:simple-materialformkdocs: Icons, Emojis](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/) -### Commonly-used icons for links: +### Commonly-used icons for links :octicons-arrow-right-16: `:octicons-arrow-right-16:` - used for links within the wiki :octicons-tab-external-16: `:octicons-tab-external-16:` - used for links outside the wiki, but within StarCat Systems :octicons-link-external-16: `:octicons-link-external-16:` - used for external links to sites not controlled by StarCat Systems +### Coloring icons +You can add a color to an icon by adding the CSS color after the icon, like this: +:fontawesome-solid-dragon:{ .bug-pink } `:fontawesome-solid-dragon:{ .bug-pink }` + + +Currently, the available configured colors are based off the built-in admonition colors and icons, as follows: + +:fontawesome-regular-note-sticky:{ .note-blue } `:fontawesome-regular-note-sticky:{ .note-blue }` +:octicons-info-16:{ .info-blue } `:octicons-info-16:{ .info-blue }` +:octicons-flame-16:{ .tip-teal } `:octicons-flame-16:{ .tip-teal }` +:octicons-check-16:{ .success-green } `:octicons-check-16:{ .success-green }` +:octicons-question-16:{ .question-green } `:octicons-question-16:{ .question-green }` +:octicons-alert-16:{ .warning-yellow } `:octicons-alert-16:{ .warning-yellow }` +:octicons-x-circle-16:{ .failure-red } `:octicons-x-circle-16:{ .failure-red }` +:octicons-zap-16:{ .danger-red } `:octicons-zap-16:{ .danger-red }` +:octicons-bug-16:{ .bug-pink } `:octicons-bug-16:{ .bug-pink }` +:octicons-beaker-16:{ .example-purple } `:octicons-beaker-16:{ .example-purple }` +:octicons-quote-16:{ .quote-grey } `:octicons-quote-16:{ .quote-grey }` + +:octicons-flame-16:{ .tip-teal } Want to know how these colors work? Check out [:simple-forgejo: the CSS in the source](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/stylesheets/extra.css). + + --- diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index c660b58..c61704b 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -1,6 +1,33 @@ +.note-blue { + color: #448AFF; + } +.info-blue { + color: #00B8D4; + } +.tip-teal { + color: #00BFA5; + } +.success-green { + color: #00C853; + } +.question-green { + color: #64DD17; + } .warning-yellow { color: #FF9100; } - .info-blue { - color: #00B8D4; +.failure-red { + color: #FF5252; + } +.danger-red { + color: #FF1744; + } +.bug-pink { + color: #F50057; + } +.example-purple { + color: #7C4DFF; + } +.quote-grey { + color: #9E9E9E; } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 1f1f1f0..b7575b3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,7 +21,7 @@ theme: favicon: assets/favicon.svg icon: admonition: - note: octicons/tag-16 + note: fontawesome/regular/note-sticky abstract: material/select-multiple info: octicons/info-16 tip: octicons/flame-16 -- 2.43.0 From 9a59faaa23d50c4b8d6ac31a65c011df17afa6e9 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 12:39:11 -0400 Subject: [PATCH 06/21] Admonitions _ common/default --- docs/handbook/meta/editing.md | 48 +++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index f6051bf..d7e6c65 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -34,6 +34,54 @@ Currently, the available configured colors are based off the built-in admonition :octicons-flame-16:{ .tip-teal } Want to know how these colors work? Check out [:simple-forgejo: the CSS in the source](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/stylesheets/extra.css). +## Admonitions +Reference for using Admonitions: [:simple-materialformkdocs: Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage) + + + +### Common Admonition Usage +Here are some common admonitions, when you might use them, and quick code snippets that you can paste in. + +!!! note + Highlights information that users should take into account, even when skimming. + + + ``` + !!! note + Highlights information that users should take into account, even when skimming. + ``` + +!!! tip + Helpful advice for doing things better or more easily. + + ``` + !!! tip + Helpful advice for doing things better or more easily. + ``` + +!!! warning + Advises about risks or negative outcomes of certain actions. + + ``` + !!! warning + Advises about risks or negative outcomes of certain actions. + ``` + +!!! danger + Urgent info that needs immediate user attention to avoid problems. + + ``` + !!! danger + Urgent info that needs immediate user attention to avoid problems. + ``` + +!!! bug + Information about a known bug in a current version. Whenever possible, provide a link to the issue report. Place a link back to the page with this admonition, in the issue report so that the admonition can be removed when the bug is closed. + + ``` + !!! bug + Information about a known bug in a current version. Whenever possible, provide a link to the issue report. Place a link back to the page with this admonition, in the issue report so that the admonition can be removed when the bug is closed. + ``` --- -- 2.43.0 From 0a6da368d4fa5ea4d9f7c6937fa1d9100b774bc8 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 12:39:50 -0400 Subject: [PATCH 07/21] Custom admonition "WIP" --- docs/handbook/meta/editing.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index d7e6c65..3f8b6a1 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -83,6 +83,26 @@ Here are some common admonitions, when you might use them, and quick code snippe Information about a known bug in a current version. Whenever possible, provide a link to the issue report. Place a link back to the page with this admonition, in the issue report so that the admonition can be removed when the bug is closed. ``` +### Custom +We've modified a couple of the standard admonitions to mean something a little different on this site. + +#### Work in Progress +For pages that aren't yet complete, and need revisions (that we know are going to be revised sooner/more frequently than a typical page.) + +Typically, we will put this at the bottom of the page content, with a dividing line between any page content and this admonition. + +Example page with this Work in Progress admonition: + +??? quote "Syntax" + Copy and paste at the bottom of page content: + ``` + --- + + !!! 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_docs) for this site. + ``` --- -- 2.43.0 From d34e35f9b47ba324d4aa0f61cff5dd28c2f2f157 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 12:48:41 -0400 Subject: [PATCH 08/21] Custom admonition: "WIP" with example page --- docs/handbook/meta/editing.md | 2 +- .../meta/example_pages/example_wip_admonition.md | 13 +++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 docs/handbook/meta/example_pages/example_wip_admonition.md diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index 3f8b6a1..3f38980 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -91,7 +91,7 @@ For pages that aren't yet complete, and need revisions (that we know are going t Typically, we will put this at the bottom of the page content, with a dividing line between any page content and this admonition. -Example page with this Work in Progress admonition: +Example page with this Work in Progress admonition: [:octicons-arrow-right-16: Example WIP Admonition](example_pages/example_wip_admonition.md) ??? quote "Syntax" Copy and paste at the bottom of page content: diff --git a/docs/handbook/meta/example_pages/example_wip_admonition.md b/docs/handbook/meta/example_pages/example_wip_admonition.md new file mode 100644 index 0000000..553f88b --- /dev/null +++ b/docs/handbook/meta/example_pages/example_wip_admonition.md @@ -0,0 +1,13 @@ +# Example page: WIP admonition +This is an example page to show the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress). You can see the source code for this page [:simple-forgejo: here]. + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere, urna a tristique hendrerit, felis elit viverra diam, vel porta ante dui a nisi. Aenean mattis nibh est, vitae tristique enim pretium et. Maecenas quis purus egestas, rutrum dolor quis, ultricies neque. Vivamus sit amet lectus ligula. Etiam scelerisque leo odio, quis suscipit felis porttitor semper. Integer eu enim vehicula, molestie elit fringilla, porttitor quam. Ut consectetur feugiat tincidunt. + +Morbi tempus pretium nisi vel bibendum. Nam ut faucibus risus, molestie aliquet odio. Sed semper, elit vel pellentesque pretium, dui odio accumsan ligula, vel gravida dui lacus ac arcu. Duis mollis purus vitae erat mattis, et mollis ipsum aliquam. Maecenas ut sagittis metus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Duis et urna eu ex imperdiet pellentesque sit amet quis eros. Nunc hendrerit venenatis odio, id condimentum leo pellentesque in. Cras vestibulum felis sed neque semper, eget dapibus ligula aliquet. + +--- + +!!! 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_docs) for this site. \ No newline at end of file -- 2.43.0 From 0e323c1e284016378eebd6ddfec1c370084e601b Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 12:51:44 -0400 Subject: [PATCH 09/21] Update custom "WIP" admonition example page --- docs/handbook/meta/example_pages/example_wip_admonition.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/handbook/meta/example_pages/example_wip_admonition.md b/docs/handbook/meta/example_pages/example_wip_admonition.md index 553f88b..4b6bc1f 100644 --- a/docs/handbook/meta/example_pages/example_wip_admonition.md +++ b/docs/handbook/meta/example_pages/example_wip_admonition.md @@ -1,5 +1,5 @@ # Example page: WIP admonition -This is an example page to show the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress). You can see the source code for this page [:simple-forgejo: here]. +This is an example page to show the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_admonition.md). Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere, urna a tristique hendrerit, felis elit viverra diam, vel porta ante dui a nisi. Aenean mattis nibh est, vitae tristique enim pretium et. Maecenas quis purus egestas, rutrum dolor quis, ultricies neque. Vivamus sit amet lectus ligula. Etiam scelerisque leo odio, quis suscipit felis porttitor semper. Integer eu enim vehicula, molestie elit fringilla, porttitor quam. Ut consectetur feugiat tincidunt. -- 2.43.0 From ad24ce13183bd248e072fc617cb6cc453b5653ba Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 12:52:27 -0400 Subject: [PATCH 10/21] Update custom "WIP" admonition example page --- docs/handbook/meta/example_pages/example_wip_admonition.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/handbook/meta/example_pages/example_wip_admonition.md b/docs/handbook/meta/example_pages/example_wip_admonition.md index 4b6bc1f..175b767 100644 --- a/docs/handbook/meta/example_pages/example_wip_admonition.md +++ b/docs/handbook/meta/example_pages/example_wip_admonition.md @@ -1,5 +1,5 @@ # Example page: WIP admonition -This is an example page to show the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_admonition.md). +This is an example page to show the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_admonition.md). Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere, urna a tristique hendrerit, felis elit viverra diam, vel porta ante dui a nisi. Aenean mattis nibh est, vitae tristique enim pretium et. Maecenas quis purus egestas, rutrum dolor quis, ultricies neque. Vivamus sit amet lectus ligula. Etiam scelerisque leo odio, quis suscipit felis porttitor semper. Integer eu enim vehicula, molestie elit fringilla, porttitor quam. Ut consectetur feugiat tincidunt. -- 2.43.0 From 466be94b5000b755b3262372ffd552df7dbb8867 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 13:07:40 -0400 Subject: [PATCH 11/21] Custom admonitions "WIP" and "Placeholder" with examples --- docs/handbook/meta/editing.md | 19 +++++++++++++++++++ .../example_placeholder_page_admonition.md | 11 +++++++++++ .../example_wip_placeholder_admonitions.md | 12 ++++++++++++ 3 files changed, 42 insertions(+) create mode 100644 docs/handbook/meta/example_pages/example_placeholder_page_admonition.md create mode 100644 docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index 3f38980..2ce77f8 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -104,6 +104,25 @@ Example page with this Work in Progress admonition: [:octicons-arrow-right-16: E 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_docs) for this site. ``` + +#### Placeholder Page +For pages that are newly created and have no (or very little) content on the page itself. Also used for `index.md` pages in directories that have other contents, but no content on the directory index. + +Example page with the Placeholder Page admonition: [:octicons-arrow-right-16: Example Placeholder Page Admonition](example_pages/example_placeholder_page_admonition.md) + +??? quote "Syntax" + Copy and paste at the bottom of page content: + ``` + !!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + ``` + +!!! tip + Typically, any page that is marked as a Placeholder Page should also be marked with the **Work in Progress** admonition because they are, by their nature, incomplete. + + Example page with the Placeholder and WIP admonitions: [:octicons-arrow-right-16: Example Placeholder and WIP Admonitions](example_pages/example_wip_placeholder_admonitions.md) + Source code that you can quickly copy from when making an index or placeholder page is located [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md). + --- !!! example "Work in Progress" diff --git a/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md b/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md new file mode 100644 index 0000000..5e01f88 --- /dev/null +++ b/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md @@ -0,0 +1,11 @@ +# Example page: Placeholder Page admonition + +!!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + +There might be a little bit of content here, but nothing substantial. + +This is an example page to show the [:octicons-arrow-right-16: Placeholder Page admonition](../editing.md#placeholder-page). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md). + +--- +Typically, you would also place a [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) on this page, as it is incomplete. For an example of a full Placeholder and WIP page, see [text](example_wip_placeholder_admonitions.md) \ No newline at end of file diff --git a/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md b/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md new file mode 100644 index 0000000..9551956 --- /dev/null +++ b/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md @@ -0,0 +1,12 @@ +# Example page: Placeholder Page and WIP admonitions + +!!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + +This is an example page to show both the [:octicons-arrow-right-16: Placeholder Page admonition](../editing.md#placeholder-page) and the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md). + +--- +!!! 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_docs) for this site. \ No newline at end of file -- 2.43.0 From c7c00891045fd67b71577ac1cf9beb8d37c6fc1c Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 15:40:13 -0400 Subject: [PATCH 12/21] Enable tooltips --- mkdocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index b7575b3..459701a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,6 +44,7 @@ theme: - navigation.top # - navigation.footer - header.autohide + - content.tooltips markdown_extensions: - admonition - pymdownx.details @@ -56,6 +57,8 @@ markdown_extensions: - tables - attr_list - md_in_html + - abbr + - pymdownx.snippets - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg -- 2.43.0 From f0b9b566c571c08d4003b489a1757cfbf377cd22 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 15:45:01 -0400 Subject: [PATCH 13/21] Enable code block highlights --- mkdocs.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 459701a..562434d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,9 +59,14 @@ markdown_extensions: - md_in_html - abbr - pymdownx.snippets + - pymdownx.inlinehilite - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true copyright: Copyright © 2025 StarCat Systems. Released under CC BY-SA 4.0 extra_css: - stylesheets/extra.css -- 2.43.0 From 48440157e6fa802e1b6f355c66ba85cef7346082 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Thu, 24 Apr 2025 13:52:25 -0400 Subject: [PATCH 14/21] Update service domains --- docs/about/service_domains.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/about/service_domains.md b/docs/about/service_domains.md index aa63344..f8a33f5 100644 --- a/docs/about/service_domains.md +++ b/docs/about/service_domains.md @@ -10,8 +10,12 @@ This list helps to ensure that you're only dealing with official, legitimate Sta - `login.starcat.systems` - the StarCat Accounts site. Use your StarCat Account to log in to all other StarCat Services. - :fontawesome-solid-triangle-exclamation:{ .warning-yellow } This is the **only** site that you should enter your StarCat Accounts login information or 2FA information into. All StarCat sites and services will redirect to `login.starcat.systems` for you to log in. - `git.starcat.systems` - the StarCat Git server, powered by Forgejo. +- `mantis.starcat.systems` - the StarCat bug and issue tracker, powered by MantisBT. +- `policies.starcat.systems` - a quick link that redirects to the Policies section of this site. +- `support.starcat.systems` - a quick link that redirects to the Support section of this site. +- `status.starcat.systems` - a quick link that redirects to our InStatus offsite status page (below). - `*.starcatsys.net` - a backend domain used to host "under the hood" apps and services. It is unlikely that you would come across this domain. -- `starcatsys.instatus.com` - hosts our off-site system status page. Sign up here to receive notifications if we're having issues with any of our systems. (This page redirects from `status.starcat.systems`.) +- `starcatsys.instatus.com` - hosts our off-site system status page. Sign up here to receive notifications if we're having issues with any of our systems. ## StarCat Services Domains List - `source.camp` - the homepage for SourceCamp -- 2.43.0 From 3ea1f9ad1ef1ee8ce6b73ddc35aed3798c52bc1d Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Thu, 24 Apr 2025 13:58:33 -0400 Subject: [PATCH 15/21] Add support pages section and index --- docs/.nav.yml | 1 + docs/support/.nav.yml | 3 +++ docs/support/index.md | 11 +++++++++++ 3 files changed, 15 insertions(+) create mode 100644 docs/support/.nav.yml create mode 100644 docs/support/index.md diff --git a/docs/.nav.yml b/docs/.nav.yml index c3d8b0b..4b3ba3b 100644 --- a/docs/.nav.yml +++ b/docs/.nav.yml @@ -6,4 +6,5 @@ nav: - stagelink - policies - handbook + - support - contact \ No newline at end of file diff --git a/docs/support/.nav.yml b/docs/support/.nav.yml new file mode 100644 index 0000000..29c3346 --- /dev/null +++ b/docs/support/.nav.yml @@ -0,0 +1,3 @@ +title: Support +nav: + - index.md \ No newline at end of file diff --git a/docs/support/index.md b/docs/support/index.md new file mode 100644 index 0000000..e0386f4 --- /dev/null +++ b/docs/support/index.md @@ -0,0 +1,11 @@ +# Get Support for StarCat Products + +!!! 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_docs) for this site. \ No newline at end of file -- 2.43.0 From 0dda3192fc4051a2c0cec2ccbd00d46e2740314a Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Thu, 24 Apr 2025 14:58:06 -0400 Subject: [PATCH 16/21] Privacy, open links in new tab --- mkdocs.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 562434d..b9cd263 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -75,6 +75,18 @@ plugins: enabled: true - search - awesome-nav + - privacy: + enabled: true + cache: false + cache_dir: .cache/plugins/privacy + log: true + assets: false + assets_fetch: true + assets_fetch_dir: assets/external + links: true + links_noopener: true + links_attr_map: + target: _blank - redirects: redirect_maps: 'editing.md': 'handbook/meta/editing.md' \ No newline at end of file -- 2.43.0 From cf5eafdf91836b9409e722041be9c0e93538cfc4 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Thu, 24 Apr 2025 14:58:21 -0400 Subject: [PATCH 17/21] Add internal handbook link icon --- docs/handbook/meta/editing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index 2ce77f8..e7bce05 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -11,7 +11,8 @@ Reference for all available Material for MkDocs icons: [:simple-materialformkdoc ### Commonly-used icons for links :octicons-arrow-right-16: `:octicons-arrow-right-16:` - used for links within the wiki :octicons-tab-external-16: `:octicons-tab-external-16:` - used for links outside the wiki, but within StarCat Systems -:octicons-link-external-16: `:octicons-link-external-16:` - used for external links to sites not controlled by StarCat Systems +:octicons-link-external-16: `:octicons-link-external-16:` - used for external links to sites not controlled by StarCat Systems +:material-book-lock: `:material-book-lock:` - used for links to the StarCat Systems internal handbook ### Coloring icons You can add a color to an icon by adding the CSS color after the icon, like this: -- 2.43.0 From 06d508562a31e203d7a1511b65f50e7085ea2f97 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Thu, 24 Apr 2025 14:58:43 -0400 Subject: [PATCH 18/21] MXroute fix internal link --- docs/handbook/infrastructure/communication/mxroute.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/handbook/infrastructure/communication/mxroute.md b/docs/handbook/infrastructure/communication/mxroute.md index 4241226..3796919 100644 --- a/docs/handbook/infrastructure/communication/mxroute.md +++ b/docs/handbook/infrastructure/communication/mxroute.md @@ -22,7 +22,9 @@ SMTP SSL: `465` SMTP Non-SSL/STARTTLS: `25` or `587` ## Additional Information -Please see the [:octicons-lock-16: MXroute](https://git.starcat.systems/starcat-internal-docs/infra/wiki/MXroute) for additional configuration and access information. + +Please see the [:material-book-lock: MXroute](https://git.starcat.systems/starcat-internal-docs/infra/wiki/MXroute) page of the internal handbook for additional configuration and access information. + --- !!! example "Work in Progress" This page is not complete, and is subject to change. -- 2.43.0 From 196c3749a772d020a0941711618021dc7630abc8 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Thu, 24 Apr 2025 15:06:35 -0400 Subject: [PATCH 19/21] Add anchor links --- mkdocs.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index b9cd263..be1d57c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -60,6 +60,11 @@ markdown_extensions: - abbr - pymdownx.snippets - pymdownx.inlinehilite + - footnotes + - toc: + slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}} + permalink: true + permalink_title: Anchor link to this section - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg -- 2.43.0 From 62f7ae699798b18ec03263eb499de0eb8aaf8d02 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Thu, 24 Apr 2025 15:31:28 -0400 Subject: [PATCH 20/21] Fix internal handbook links --- docs/handbook/infrastructure/communication/mxroute.md | 2 +- docs/handbook/infrastructure/communication/voipms.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/handbook/infrastructure/communication/mxroute.md b/docs/handbook/infrastructure/communication/mxroute.md index 3796919..38c4f1f 100644 --- a/docs/handbook/infrastructure/communication/mxroute.md +++ b/docs/handbook/infrastructure/communication/mxroute.md @@ -23,7 +23,7 @@ SMTP Non-SSL/STARTTLS: `25` or `587` ## Additional Information -Please see the [:material-book-lock: MXroute](https://git.starcat.systems/starcat-internal-docs/infra/wiki/MXroute) page of the internal handbook for additional configuration and access information. +Please see the [:material-book-lock: MXroute](https://internal-handbook.starcatsys.net/infrastructure_apps/communication/mxroute/) page of the internal handbook for additional configuration and access information. --- !!! example "Work in Progress" diff --git a/docs/handbook/infrastructure/communication/voipms.md b/docs/handbook/infrastructure/communication/voipms.md index 343a7d9..faa6493 100644 --- a/docs/handbook/infrastructure/communication/voipms.md +++ b/docs/handbook/infrastructure/communication/voipms.md @@ -2,14 +2,14 @@ [:octicons-link-external-16: Voip.ms](https://voip.ms/) provides phone numbers, calls, and text messages for corporate phone, and app communications. ## Quick Links -[:octicons-link-external-16: Control panel](https://voip.ms/signin/index.php?ln=en) - limited access, contact admin if you need access or need to make changes +[:octicons-link-external-16: Control panel](https://voip.ms/signin/index.php?ln=en) - limited access, contact admin if you need access or need to make changes ## Current Setup ### Incoming Calls When someone calls our main number, the IVR tells them to visit our website for the most efficient support, or they can press ++5++ to leave a voicemail. They can also enter an extension to be forwarded out to a user's direct line, or press ++9++ to have the recording repeated. ### Outgoing Calls -If you need to make an outbound call from our main number, call the main number and press ++7++. Enter the outbound calls passcode (ask admin if you need the passcode), and then follow the prompts to place the call. +If you need to make an outbound call from our main number, call the main number and press ++7++. Enter the outbound calls passcode (linked [:material-book-lock: here](https://internal-handbook.starcatsys.net/reference/starcat_meta/phone/#outbound-calls)), and then follow the prompts to place the call. ### Voicemails By default, all voicemail messages are automatically emailed as an MP3 attachment and deleted from the system. The "Main VM" that incoming callers are directed to from the main menu is emailed to the `voipms_vm_main@starcatsys.net` email group. -- 2.43.0 From 2506834e4d21c43529fe2d84e55359ba8a08a1b7 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Thu, 24 Apr 2025 15:45:43 -0400 Subject: [PATCH 21/21] Flesh out NFSN --- .../infrastructure/servers_and_hosting/nfsn.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/handbook/infrastructure/servers_and_hosting/nfsn.md b/docs/handbook/infrastructure/servers_and_hosting/nfsn.md index 6846073..3973479 100644 --- a/docs/handbook/infrastructure/servers_and_hosting/nfsn.md +++ b/docs/handbook/infrastructure/servers_and_hosting/nfsn.md @@ -1,7 +1,14 @@ # NFSN -!!! abstract "Placeholder Page" - This is a placeholder page. Please see the site navigation for any sub-pages that exist. +[:octicons-link-external-16: NearlyFreeSpeech.Net](https://www.nearlyfreespeech.net) is a web hosting provider that hosts some of our static and dynamic web pages and apps. We also make use of their MySQL hosting. + +## Quick Links +[:octicons-link-external-16: Control panel](https://members.nearlyfreespeech.net/login/) - limited access, you **must** have an NFSN login, and be invited to our project(s). +[:octicons-link-external-16: phpMyAdmin](https://phpmyadmin.nearlyfreespeech.net/) - web-based MySQL DB access. You will need a personal MySQL login, or get one from the secrets system. + +## Additional Information +Please see the [:material-book-lock: NFSN](https://internal-handbook.starcatsys.net/infrastructure_apps/servers_hosting/nfsn/) page of the internal handbook for additional configuration and access information. + --- -- 2.43.0