From 5de44da802507dc0cbc58f9d55202b29cb2ffa59 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 13:01:20 -0400 Subject: [PATCH 01/21] Mkdir communication --- .../handbook/infrastructure/providers/communication/.nav.yml | 5 +++++ .../handbook/infrastructure/providers/communication/index.md | 1 + .../infrastructure/providers/communication/voipms.md | 1 + 3 files changed, 7 insertions(+) create mode 100644 docs/handbook/infrastructure/providers/communication/.nav.yml create mode 100644 docs/handbook/infrastructure/providers/communication/index.md create mode 100644 docs/handbook/infrastructure/providers/communication/voipms.md diff --git a/docs/handbook/infrastructure/providers/communication/.nav.yml b/docs/handbook/infrastructure/providers/communication/.nav.yml new file mode 100644 index 0000000..b55b20c --- /dev/null +++ b/docs/handbook/infrastructure/providers/communication/.nav.yml @@ -0,0 +1,5 @@ +title: Communication +nav: + - index.md + - mxroute.md + - voipms.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/communication/index.md b/docs/handbook/infrastructure/providers/communication/index.md new file mode 100644 index 0000000..7e37400 --- /dev/null +++ b/docs/handbook/infrastructure/providers/communication/index.md @@ -0,0 +1 @@ +# Communication \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/communication/voipms.md b/docs/handbook/infrastructure/providers/communication/voipms.md new file mode 100644 index 0000000..b6cc68a --- /dev/null +++ b/docs/handbook/infrastructure/providers/communication/voipms.md @@ -0,0 +1 @@ +# Voip.ms \ No newline at end of file -- 2.43.0 From a9a7374385b0670a85d67e319d014730db0b458e Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 13:01:31 -0400 Subject: [PATCH 02/21] mv MXroute --- .../infrastructure/providers/{ => communication}/mxroute.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/handbook/infrastructure/providers/{ => communication}/mxroute.md (100%) diff --git a/docs/handbook/infrastructure/providers/mxroute.md b/docs/handbook/infrastructure/providers/communication/mxroute.md similarity index 100% rename from docs/handbook/infrastructure/providers/mxroute.md rename to docs/handbook/infrastructure/providers/communication/mxroute.md -- 2.43.0 From bb45cf72faadba1ad07de1a54d9327ce5cb1e598 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 13:01:42 -0400 Subject: [PATCH 03/21] mkdir network --- docs/handbook/infrastructure/providers/network/.nav.yml | 4 ++++ docs/handbook/infrastructure/providers/network/bunny.md | 1 + docs/handbook/infrastructure/providers/network/index.md | 1 + 3 files changed, 6 insertions(+) create mode 100644 docs/handbook/infrastructure/providers/network/.nav.yml create mode 100644 docs/handbook/infrastructure/providers/network/bunny.md create mode 100644 docs/handbook/infrastructure/providers/network/index.md diff --git a/docs/handbook/infrastructure/providers/network/.nav.yml b/docs/handbook/infrastructure/providers/network/.nav.yml new file mode 100644 index 0000000..f5adff4 --- /dev/null +++ b/docs/handbook/infrastructure/providers/network/.nav.yml @@ -0,0 +1,4 @@ +title: Network +nav: + - index.md + - bunny.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/network/bunny.md b/docs/handbook/infrastructure/providers/network/bunny.md new file mode 100644 index 0000000..e668c58 --- /dev/null +++ b/docs/handbook/infrastructure/providers/network/bunny.md @@ -0,0 +1 @@ +# Bunny \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/network/index.md b/docs/handbook/infrastructure/providers/network/index.md new file mode 100644 index 0000000..5686306 --- /dev/null +++ b/docs/handbook/infrastructure/providers/network/index.md @@ -0,0 +1 @@ +# Network \ No newline at end of file -- 2.43.0 From 747e10801596c367cfb692b7c93949a26185fdab Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 13:01:52 -0400 Subject: [PATCH 04/21] mkdir servers + hosting --- .../infrastructure/providers/servers_and_hosting/.nav.yml | 5 +++++ .../infrastructure/providers/servers_and_hosting/index.md | 1 + .../infrastructure/providers/servers_and_hosting/nfsn.md | 1 + 3 files changed, 7 insertions(+) create mode 100644 docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml create mode 100644 docs/handbook/infrastructure/providers/servers_and_hosting/index.md create mode 100644 docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml b/docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml new file mode 100644 index 0000000..fcc485a --- /dev/null +++ b/docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml @@ -0,0 +1,5 @@ +title: Servers + Hosting +nav: + - index.md + - hetzner.md + - nfsn.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/index.md b/docs/handbook/infrastructure/providers/servers_and_hosting/index.md new file mode 100644 index 0000000..90c21a2 --- /dev/null +++ b/docs/handbook/infrastructure/providers/servers_and_hosting/index.md @@ -0,0 +1 @@ +# Servers and Hosting \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md b/docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md new file mode 100644 index 0000000..eb43262 --- /dev/null +++ b/docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md @@ -0,0 +1 @@ +# NFSN \ No newline at end of file -- 2.43.0 From 07eb30b135727cc5789d276b39a330482516647e Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 13:02:03 -0400 Subject: [PATCH 05/21] mv hetzner --- .../infrastructure/providers/{ => servers_and_hosting}/hetzner.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/handbook/infrastructure/providers/{ => servers_and_hosting}/hetzner.md (100%) diff --git a/docs/handbook/infrastructure/providers/hetzner.md b/docs/handbook/infrastructure/providers/servers_and_hosting/hetzner.md similarity index 100% rename from docs/handbook/infrastructure/providers/hetzner.md rename to docs/handbook/infrastructure/providers/servers_and_hosting/hetzner.md -- 2.43.0 From 224935cac9533501069ad6f91d63d35ac5957f74 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 13:02:08 -0400 Subject: [PATCH 06/21] Update .nav.yml --- docs/handbook/infrastructure/providers/.nav.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/handbook/infrastructure/providers/.nav.yml b/docs/handbook/infrastructure/providers/.nav.yml index 332c48e..c2f00e6 100644 --- a/docs/handbook/infrastructure/providers/.nav.yml +++ b/docs/handbook/infrastructure/providers/.nav.yml @@ -1,5 +1,6 @@ title: Providers nav: - index.md - - hetzner.md - - mxroute.md \ No newline at end of file + - servers_and_hosting + - network + - communication \ No newline at end of file -- 2.43.0 From 7c98db5125cf40d2d0b28ebe8040e40f10fe95c4 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 13:39:45 -0400 Subject: [PATCH 07/21] Build out placehold page labels --- docs/about/index.md | 12 +++++++++++- docs/contact/index.md | 12 +++++++++++- docs/docshq/index.md | 12 +++++++++++- docs/handbook/index.md | 12 +++++++++++- docs/handbook/infrastructure/index.md | 13 ++++++++++++- .../infrastructure/providers/communication/index.md | 12 +++++++++++- .../providers/communication/mxroute.md | 8 +++++++- .../providers/communication/voipms.md | 9 ++++++++- docs/handbook/infrastructure/providers/index.md | 12 +++++++++++- .../providers/servers_and_hosting/index.md | 12 +++++++++++- docs/handbook/meta/index.md | 12 +++++++++++- docs/policies/index.md | 12 +++++++++++- docs/postline/index.md | 12 +++++++++++- docs/sourcecamp/index.md | 12 +++++++++++- docs/stagelink/index.md | 12 +++++++++++- mkdocs.yml | 4 ++-- 16 files changed, 161 insertions(+), 17 deletions(-) diff --git a/docs/about/index.md b/docs/about/index.md index ca1e30b..a73b379 100644 --- a/docs/about/index.md +++ b/docs/about/index.md @@ -1 +1,11 @@ -# About \ No newline at end of file +# About + +!!! 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](../../../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 diff --git a/docs/contact/index.md b/docs/contact/index.md index 2d6cfad..ad82c47 100644 --- a/docs/contact/index.md +++ b/docs/contact/index.md @@ -1 +1,11 @@ -# Contact StarCat Systems \ No newline at end of file +# Contact StarCat Systems + +!!! 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](../../../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 diff --git a/docs/docshq/index.md b/docs/docshq/index.md index b3a9bb4..12f4f45 100644 --- a/docs/docshq/index.md +++ b/docs/docshq/index.md @@ -1 +1,11 @@ -# DocsHQ \ No newline at end of file +# DocsHQ + +!!! 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](../../../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 diff --git a/docs/handbook/index.md b/docs/handbook/index.md index c183ab2..ba28d69 100644 --- a/docs/handbook/index.md +++ b/docs/handbook/index.md @@ -1 +1,11 @@ -# StarCat Systems Handbook \ No newline at end of file +# StarCat Systems Handbook + +!!! 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](../../../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 diff --git a/docs/handbook/infrastructure/index.md b/docs/handbook/infrastructure/index.md index 90c21fe..42c429f 100644 --- a/docs/handbook/infrastructure/index.md +++ b/docs/handbook/infrastructure/index.md @@ -1,2 +1,13 @@ # Infrastructure -Various things related to the servers, systems, and services that power all StarCat creations. \ No newline at end of file +Various things related to the servers, systems, and services that power all StarCat creations. + + +!!! 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](../../../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 diff --git a/docs/handbook/infrastructure/providers/communication/index.md b/docs/handbook/infrastructure/providers/communication/index.md index 7e37400..d4422da 100644 --- a/docs/handbook/infrastructure/providers/communication/index.md +++ b/docs/handbook/infrastructure/providers/communication/index.md @@ -1 +1,11 @@ -# Communication \ No newline at end of file +# Communication + +!!! 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](../../../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 diff --git a/docs/handbook/infrastructure/providers/communication/mxroute.md b/docs/handbook/infrastructure/providers/communication/mxroute.md index 99d476c..54e6acf 100644 --- a/docs/handbook/infrastructure/providers/communication/mxroute.md +++ b/docs/handbook/infrastructure/providers/communication/mxroute.md @@ -3,4 +3,10 @@ [:octicons-link-external-24: MXroute](https://mxroute.com/) hosts our email servers for coporate email, transactional messages, and Postline groups. ## Connection Information -Please see the [:octicons-lock-16: MXroute](https://git.starcat.systems/starcat-internal-docs/infra/wiki/MXroute) page of the internal wiki for connection and access information. \ No newline at end of file +Please see the [:octicons-lock-16: MXroute](https://git.starcat.systems/starcat-internal-docs/infra/wiki/MXroute) page of the internal wiki for connection and access information. + +--- +!!! 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 diff --git a/docs/handbook/infrastructure/providers/communication/voipms.md b/docs/handbook/infrastructure/providers/communication/voipms.md index b6cc68a..d441377 100644 --- a/docs/handbook/infrastructure/providers/communication/voipms.md +++ b/docs/handbook/infrastructure/providers/communication/voipms.md @@ -1 +1,8 @@ -# Voip.ms \ No newline at end of file +# Voip.ms +[:octicons-link-external-24: Voip.ms](https://voip.ms/) provides phone numbers, calls, and text messages for corporate phone, and app communications. + +--- +!!! 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 diff --git a/docs/handbook/infrastructure/providers/index.md b/docs/handbook/infrastructure/providers/index.md index 64708b7..c687e2f 100644 --- a/docs/handbook/infrastructure/providers/index.md +++ b/docs/handbook/infrastructure/providers/index.md @@ -1 +1,11 @@ -# Infrastructure Providers \ No newline at end of file +# 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](../../../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 diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/index.md b/docs/handbook/infrastructure/providers/servers_and_hosting/index.md index 90c21a2..2c3d01b 100644 --- a/docs/handbook/infrastructure/providers/servers_and_hosting/index.md +++ b/docs/handbook/infrastructure/providers/servers_and_hosting/index.md @@ -1 +1,11 @@ -# Servers and Hosting \ No newline at end of file +# Servers and Hosting + +!!! 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](../../../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 diff --git a/docs/handbook/meta/index.md b/docs/handbook/meta/index.md index 8c6c56b..fd82098 100644 --- a/docs/handbook/meta/index.md +++ b/docs/handbook/meta/index.md @@ -1 +1,11 @@ -# Handbook Meta \ No newline at end of file +# Handbook Meta + +!!! 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](../../../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 diff --git a/docs/policies/index.md b/docs/policies/index.md index e5fd1e8..457a142 100644 --- a/docs/policies/index.md +++ b/docs/policies/index.md @@ -1 +1,11 @@ -# Policies \ No newline at end of file +# Policies + +!!! 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](../../../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 diff --git a/docs/postline/index.md b/docs/postline/index.md index 476c49b..12f9e87 100644 --- a/docs/postline/index.md +++ b/docs/postline/index.md @@ -1 +1,11 @@ -# Postline \ No newline at end of file +# Postline + +!!! 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](../../../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 diff --git a/docs/sourcecamp/index.md b/docs/sourcecamp/index.md index a11e0f4..87973da 100644 --- a/docs/sourcecamp/index.md +++ b/docs/sourcecamp/index.md @@ -1 +1,11 @@ -# SourceCamp \ No newline at end of file +# SourceCamp + +!!! 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](../../../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 diff --git a/docs/stagelink/index.md b/docs/stagelink/index.md index 7681518..a2ea13e 100644 --- a/docs/stagelink/index.md +++ b/docs/stagelink/index.md @@ -1 +1,11 @@ -# StageLink \ No newline at end of file +# StageLink + +!!! 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](../../../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 diff --git a/mkdocs.yml b/mkdocs.yml index d26890f..4dfdb82 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,9 +20,9 @@ theme: icon: admonition: note: octicons/tag-16 - abstract: octicons/checklist-16 + abstract: material/select-multiple info: octicons/info-16 - tip: octicons/squirrel-16 + tip: octicons/flame-16 success: octicons/check-16 question: octicons/question-16 warning: octicons/alert-16 -- 2.43.0 From 1366ff1449527f64abb978c8790ac87b8f36da3f Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 13:56:12 -0400 Subject: [PATCH 08/21] Update site colors --- mkdocs.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 4dfdb82..74c8b54 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,13 +5,15 @@ theme: palette: - media: "(prefers-color-scheme: light)" scheme: default - primary: black + primary: deep purple + accent: light blue toggle: icon: material/lightbulb name: Switch to dark mode - media: "(prefers-color-scheme: dark)" scheme: slate - primary: black + primary: deep purple + accent: light blue toggle: icon: material/lightbulb-outline name: Switch to light mode -- 2.43.0 From ce7b7e7fcc115a43c91f259db53511b04214546e Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 14:12:58 -0400 Subject: [PATCH 09/21] mk editing.md redir editing.md to /handbook/meta/editing.md Fix placeholder admonitions to editing.md --- docs/about/index.md | 2 +- docs/contact/index.md | 2 +- docs/docshq/index.md | 2 +- docs/editing.md | 1 + docs/handbook/index.md | 2 +- docs/handbook/infrastructure/index.md | 2 +- .../infrastructure/providers/communication/index.md | 2 +- .../providers/communication/mxroute.md | 2 +- docs/handbook/infrastructure/providers/index.md | 2 +- .../infrastructure/providers/network/index.md | 12 +++++++++++- .../providers/servers_and_hosting/index.md | 2 +- docs/handbook/meta/index.md | 2 +- docs/index.md | 2 +- docs/policies/index.md | 2 +- docs/postline/index.md | 2 +- docs/sourcecamp/index.md | 2 +- docs/stagelink/index.md | 2 +- mkdocs.yml | 5 ++++- 18 files changed, 31 insertions(+), 17 deletions(-) create mode 100644 docs/editing.md diff --git a/docs/about/index.md b/docs/about/index.md index a73b379..5682444 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](../../../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/contact/index.md b/docs/contact/index.md index ad82c47..9c43bac 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](../../../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/docshq/index.md b/docs/docshq/index.md index 12f4f45..ff102b8 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](../../../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/editing.md b/docs/editing.md new file mode 100644 index 0000000..6da0858 --- /dev/null +++ b/docs/editing.md @@ -0,0 +1 @@ +This page is solely to redirect to `handbook/meta/editing.md` from various locations. \ No newline at end of file diff --git a/docs/handbook/index.md b/docs/handbook/index.md index ba28d69..dc1db38 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](../../../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/index.md b/docs/handbook/infrastructure/index.md index 42c429f..4d4c775 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](../../../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/providers/communication/index.md b/docs/handbook/infrastructure/providers/communication/index.md index d4422da..521767d 100644 --- a/docs/handbook/infrastructure/providers/communication/index.md +++ b/docs/handbook/infrastructure/providers/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](../../../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/providers/communication/mxroute.md b/docs/handbook/infrastructure/providers/communication/mxroute.md index 54e6acf..e42ce67 100644 --- a/docs/handbook/infrastructure/providers/communication/mxroute.md +++ b/docs/handbook/infrastructure/providers/communication/mxroute.md @@ -9,4 +9,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](../../../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/providers/index.md b/docs/handbook/infrastructure/providers/index.md index c687e2f..b6686a8 100644 --- a/docs/handbook/infrastructure/providers/index.md +++ b/docs/handbook/infrastructure/providers/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](../../../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/providers/network/index.md b/docs/handbook/infrastructure/providers/network/index.md index 5686306..c17e3ec 100644 --- a/docs/handbook/infrastructure/providers/network/index.md +++ b/docs/handbook/infrastructure/providers/network/index.md @@ -1 +1,11 @@ -# Network \ No newline at end of file +# Network + +!!! 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/index.md b/docs/handbook/infrastructure/providers/servers_and_hosting/index.md index 2c3d01b..5d4bde8 100644 --- a/docs/handbook/infrastructure/providers/servers_and_hosting/index.md +++ b/docs/handbook/infrastructure/providers/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](../../../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/meta/index.md b/docs/handbook/meta/index.md index fd82098..b18a25e 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](../../../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/index.md b/docs/index.md index f053d8b..1d570e8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -82,7 +82,7 @@ You'll find the following sections of information on this site: ## :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](handbook/meta/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-24: 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 457a142..de213c5 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](../../../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/postline/index.md b/docs/postline/index.md index 12f9e87..908d316 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](../../../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/sourcecamp/index.md b/docs/sourcecamp/index.md index 87973da..64c35ef 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](../../../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/stagelink/index.md b/docs/stagelink/index.md index a2ea13e..607f3c3 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](../../../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/mkdocs.yml b/mkdocs.yml index 74c8b54..252d18f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -64,4 +64,7 @@ plugins: - typeset: enabled: true - search - - awesome-nav \ No newline at end of file + - awesome-nav + - redirects: + redirect_maps: + 'editing.md': 'handbook/meta/editing.md' \ No newline at end of file -- 2.43.0 From d26b4a5b97285f7a473469082ee8e302cc7dc135 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 18:31:51 -0400 Subject: [PATCH 10/21] Create Attribution and Service Domains pages --- docs/about/.nav.yml | 4 +++- docs/about/attribution.md | 12 ++++++++++++ docs/about/service_domains.md | 13 +++++++++++++ 3 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 docs/about/attribution.md create mode 100644 docs/about/service_domains.md diff --git a/docs/about/.nav.yml b/docs/about/.nav.yml index a95f0b9..58f9295 100644 --- a/docs/about/.nav.yml +++ b/docs/about/.nav.yml @@ -1,3 +1,5 @@ title: About nav: - - index.md \ No newline at end of file + - index.md + - service_domains.md + - attribution.md \ No newline at end of file diff --git a/docs/about/attribution.md b/docs/about/attribution.md new file mode 100644 index 0000000..8d1144f --- /dev/null +++ b/docs/about/attribution.md @@ -0,0 +1,12 @@ +# Attribution +This site, and all StarCat Systems projects, products, and services make use of open-source and freely-available content. We want to attribute those creators here. + +## Icons +- [StarCat Systems](https://starcat.systems) logo - adapted from [Cat](https://thenounproject.com/icon/cat-6441095/) by [Md Ahasan Habib](https://thenounproject.com/creator/md_ahasan/) from Noun Project. +- [`about` site](https://about.starcat.systems) icon - adapted from [Book](https://thenounproject.com/icon/book-7745194/) by [Kawalan Icon](https://thenounproject.com/creator/kawalan.studio/) from Noun Project. +- [`about-docs` repo](https://git.starcat.systems/starcatsys/about_docs) icon - adapted from [Book](https://thenounproject.com/icon/book-1833960/) by [Untashable](https://thenounproject.com/creator/untashable/) from Noun Project. +- [`starcat-infra` org](https://git.starcat.systems/starcat-infra) icon - adapted from [Engineering](https://thenounproject.com/icon/engineering-7486606/) by [sunardi](https://thenounproject.com/creator/matah3574/) from Noun Project. +- [`starcat-dev` org](https://git.starcat.systems/starcat-dev) icon - adapted from [lab](https://thenounproject.com/icon/lab-4581077/) by [cr9183353](https://thenounproject.com/creator/cr9183353/) from Noun Project. +- [Git server](https://git.starcat.systems/) icon - adapted from [Arcticons Thin Line Icons Collection](https://www.svgrepo.com/collection/arcticons-thin-line-icons/) by [Donnnno](https://www.svgrepo.com/author/Donnnno/) and from the StarCat Systems logo, above. +- [SourceCamp](https://source.camp) logo - adapted from [camp](https://thenounproject.com/icon/camp-7375488/) by [Ricons](https://thenounproject.com/creator/ricons/) from Noun Project. +- Icons used on this `about` site are by [Material Design](https://pictogrammers.com/library/mdi/), [FontAwesome](https://fontawesome.com/search?m=free), [Octicons](https://octicons.github.com/), and [Simple Icons](https://simpleicons.org/). \ No newline at end of file diff --git a/docs/about/service_domains.md b/docs/about/service_domains.md new file mode 100644 index 0000000..8047c12 --- /dev/null +++ b/docs/about/service_domains.md @@ -0,0 +1,13 @@ +# Service Domains +Here is a list of all domain names used by StarCat Systems and its projects and services. + +## Why does this list exist? +This list helps to ensure that you're only dealing with official, legitimate StarCat services. If you come across a site with a domain name that is not on this list, **do not** provide any personal or login information, and please contact Security immediately. + +## StarCat Service Domains List +- `starcat.systems` - the StarCat Systems homepage. Also hosts certain sites and services on its subdomains (like this site!) +- `about.starcat.systems` - the site that you're on right now! Our wiki and documentation site for all things StarCat. +- `login.starcat.systems` - the StarCat Accounts site. Use your StarCat Account to log in to all other StarCat Services. + - :fontawesome-solid-triangle-exclamation: This is the **only** site that you should enter your login information or 2FA information into. All StarCat sites and services will redirect to `login.starcat.systems` for you to log in. +- `*.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. \ No newline at end of file -- 2.43.0 From 47d97e55850dff33bb6c40bedc45d571c93e1ce9 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 7 Apr 2025 18:55:21 -0400 Subject: [PATCH 11/21] Update to head-in-circle icon, book favicon --- docs/about/attribution.md | 2 +- docs/assets/favicon.svg | 41 ++++++++++++++++++- docs/assets/starcat_cat-icon_white_tp.svg | 12 ------ .../starcat_cat-icon_white_tp_smaller.svg | 16 -------- ...cat_head-circle-only-white-transparent.svg | 16 ++++++++ ...d-circle-only-white-transparent_larger.svg | 16 ++++++++ mkdocs.yml | 2 +- 7 files changed, 74 insertions(+), 31 deletions(-) delete mode 100644 docs/assets/starcat_cat-icon_white_tp.svg delete mode 100644 docs/assets/starcat_cat-icon_white_tp_smaller.svg create mode 100644 docs/assets/starcat_head-circle-only-white-transparent.svg create mode 100644 docs/assets/starcat_head-circle-only-white-transparent_larger.svg diff --git a/docs/about/attribution.md b/docs/about/attribution.md index 8d1144f..71046f4 100644 --- a/docs/about/attribution.md +++ b/docs/about/attribution.md @@ -3,7 +3,7 @@ This site, and all StarCat Systems projects, products, and services make use of ## Icons - [StarCat Systems](https://starcat.systems) logo - adapted from [Cat](https://thenounproject.com/icon/cat-6441095/) by [Md Ahasan Habib](https://thenounproject.com/creator/md_ahasan/) from Noun Project. -- [`about` site](https://about.starcat.systems) icon - adapted from [Book](https://thenounproject.com/icon/book-7745194/) by [Kawalan Icon](https://thenounproject.com/creator/kawalan.studio/) from Noun Project. +- [`about` site](https://about.starcat.systems) favicon - adapted from [Book](https://thenounproject.com/icon/book-6252926/) by [iconpro86](https://thenounproject.com/creator/iconpro86/) from Noun Project. - [`about-docs` repo](https://git.starcat.systems/starcatsys/about_docs) icon - adapted from [Book](https://thenounproject.com/icon/book-1833960/) by [Untashable](https://thenounproject.com/creator/untashable/) from Noun Project. - [`starcat-infra` org](https://git.starcat.systems/starcat-infra) icon - adapted from [Engineering](https://thenounproject.com/icon/engineering-7486606/) by [sunardi](https://thenounproject.com/creator/matah3574/) from Noun Project. - [`starcat-dev` org](https://git.starcat.systems/starcat-dev) icon - adapted from [lab](https://thenounproject.com/icon/lab-4581077/) by [cr9183353](https://thenounproject.com/creator/cr9183353/) from Noun Project. diff --git a/docs/assets/favicon.svg b/docs/assets/favicon.svg index 511c5cc..2e2505a 100644 --- a/docs/assets/favicon.svg +++ b/docs/assets/favicon.svg @@ -1 +1,40 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/assets/starcat_cat-icon_white_tp.svg b/docs/assets/starcat_cat-icon_white_tp.svg deleted file mode 100644 index 8815c92..0000000 --- a/docs/assets/starcat_cat-icon_white_tp.svg +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/docs/assets/starcat_cat-icon_white_tp_smaller.svg b/docs/assets/starcat_cat-icon_white_tp_smaller.svg deleted file mode 100644 index 28c8a45..0000000 --- a/docs/assets/starcat_cat-icon_white_tp_smaller.svg +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/assets/starcat_head-circle-only-white-transparent.svg b/docs/assets/starcat_head-circle-only-white-transparent.svg new file mode 100644 index 0000000..d1bdb52 --- /dev/null +++ b/docs/assets/starcat_head-circle-only-white-transparent.svg @@ -0,0 +1,16 @@ + + + + + + + + + + diff --git a/docs/assets/starcat_head-circle-only-white-transparent_larger.svg b/docs/assets/starcat_head-circle-only-white-transparent_larger.svg new file mode 100644 index 0000000..dc111e3 --- /dev/null +++ b/docs/assets/starcat_head-circle-only-white-transparent_larger.svg @@ -0,0 +1,16 @@ + + + + + + + + + + diff --git a/mkdocs.yml b/mkdocs.yml index 252d18f..04adfba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,7 +17,7 @@ theme: toggle: icon: material/lightbulb-outline name: Switch to light mode - logo: assets/starcat_cat-icon_white_tp.svg + logo: assets/starcat_head-circle-only-white-transparent_larger.svg favicon: assets/favicon.svg icon: admonition: -- 2.43.0 From 762e29f50c312b06364cdede7ecc60e317600ae4 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 15:02:56 -0400 Subject: [PATCH 12/21] Complete Service Domains list, add CSS for colored icons --- docs/about/service_domains.md | 30 +++++++++++++++++++++++++++--- docs/stylesheets/extra.css | 6 ++++++ mkdocs.yml | 2 ++ 3 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 docs/stylesheets/extra.css diff --git a/docs/about/service_domains.md b/docs/about/service_domains.md index 8047c12..aa63344 100644 --- a/docs/about/service_domains.md +++ b/docs/about/service_domains.md @@ -4,10 +4,34 @@ Here is a list of all domain names used by StarCat Systems and its projects and ## Why does this list exist? This list helps to ensure that you're only dealing with official, legitimate StarCat services. If you come across a site with a domain name that is not on this list, **do not** provide any personal or login information, and please contact Security immediately. -## StarCat Service Domains List +## StarCat Global Domains List - `starcat.systems` - the StarCat Systems homepage. Also hosts certain sites and services on its subdomains (like this site!) - `about.starcat.systems` - the site that you're on right now! Our wiki and documentation site for all things StarCat. - `login.starcat.systems` - the StarCat Accounts site. Use your StarCat Account to log in to all other StarCat Services. - - :fontawesome-solid-triangle-exclamation: This is the **only** site that you should enter your login information or 2FA information into. All StarCat sites and services will redirect to `login.starcat.systems` for you to log in. + - :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. - `*.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. \ No newline at end of file +- `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`.) + +## StarCat Services Domains List +- `source.camp` - the homepage for SourceCamp +- `docshq.app` - the homepage for DocsHQ +- `postline.email` - the homepage for Postline +- `stagelink.cloud` - the homepage for StageLink + +## Hosted Services Subdomains List +!!! warning "Warning: Third Party Content" + Any content that is hosted under these subdomains is not published by StarCat Systems. Do **NOT** enter your StarCat Accounts login or 2FA information into **any** page under these subdomains. + + If you are asked for your StarCat Accounts login or 2FA information on *any* site that is not `login.starcat.systems`, please contact Security immediately. + +- `*.starcathosted.com` (e.g., `example.starcathosted.com`) +- `*.hosted.source.camp` (e.g., `example.hosted.source.camp`) + - :octicons-info-16:{ .info-blue } These subdomains host users' Forgejo instances. If you are an owner or user of one of these instances, you should use your Forgejo login information to sign in to Forgejo. Do not use your StarCat Accounts login information. +- `*.hosted.docshq.app` (e.g., `example.hosted.docshq.app`) + - :octicons-info-16:{ .info-blue } If your DocsHQ site is set to require authentication, you will be redirected to `auth.examplesite.hosted.docshq.app` to log in with your company credentials. Do not use your StarCat Accounts login information. +- `lists.postline.email` + - :octicons-info-16:{ .info-blue } When you create or subscribe to a Postline list, you will be prompted to create a separate Postline login which will only work with Postline lists. Do not use your StarCat Accounts login information. +- `*.dedicated.postline.email` (e.g., `example.dedicated.postline.email`) + - :octicons-info-16:{ .info-blue } For Postline Dedicated servers, you will be prompted to create a separate login for your dedicated server, which you will use to administer the server, manage and/or subscribe to lists, etc. Do not use your StarCat Accounts login information. +- `*.connect.stagelink.cloud` (e.g., `example.connect.stagelink.cloud`) \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..c660b58 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,6 @@ +.warning-yellow { + color: #FF9100; + } + .info-blue { + color: #00B8D4; + } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 04adfba..1f1f1f0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -60,6 +60,8 @@ markdown_extensions: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg copyright: Copyright © 2025 StarCat Systems. Released under CC BY-SA 4.0 +extra_css: + - stylesheets/extra.css plugins: - typeset: enabled: true -- 2.43.0 From 611e28998a6135ab62dc748412045c438da3bcd1 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 16:06:41 -0400 Subject: [PATCH 13/21] Mk infrastructure/apps with Uptime and Beszel --- docs/handbook/infrastructure/apps/.nav.yml | 4 ++++ docs/handbook/infrastructure/apps/index.md | 11 +++++++++++ .../infrastructure/apps/monitoring/.nav.yml | 5 +++++ .../infrastructure/apps/monitoring/beszel.md | 14 ++++++++++++++ .../infrastructure/apps/monitoring/index.md | 11 +++++++++++ .../infrastructure/apps/monitoring/uptime.md | 16 ++++++++++++++++ 6 files changed, 61 insertions(+) create mode 100644 docs/handbook/infrastructure/apps/.nav.yml create mode 100644 docs/handbook/infrastructure/apps/index.md create mode 100644 docs/handbook/infrastructure/apps/monitoring/.nav.yml create mode 100644 docs/handbook/infrastructure/apps/monitoring/beszel.md create mode 100644 docs/handbook/infrastructure/apps/monitoring/index.md create mode 100644 docs/handbook/infrastructure/apps/monitoring/uptime.md diff --git a/docs/handbook/infrastructure/apps/.nav.yml b/docs/handbook/infrastructure/apps/.nav.yml new file mode 100644 index 0000000..1e599be --- /dev/null +++ b/docs/handbook/infrastructure/apps/.nav.yml @@ -0,0 +1,4 @@ +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 new file mode 100644 index 0000000..88f8079 --- /dev/null +++ b/docs/handbook/infrastructure/apps/index.md @@ -0,0 +1,11 @@ +# 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/apps/monitoring/.nav.yml b/docs/handbook/infrastructure/apps/monitoring/.nav.yml new file mode 100644 index 0000000..10c0e35 --- /dev/null +++ b/docs/handbook/infrastructure/apps/monitoring/.nav.yml @@ -0,0 +1,5 @@ +title: Monitoring +nav: + - index.md + - beszel.md + - uptime.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/apps/monitoring/beszel.md b/docs/handbook/infrastructure/apps/monitoring/beszel.md new file mode 100644 index 0000000..76af88f --- /dev/null +++ b/docs/handbook/infrastructure/apps/monitoring/beszel.md @@ -0,0 +1,14 @@ +# Beszel + +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` + +--- + +!!! 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/apps/monitoring/index.md b/docs/handbook/infrastructure/apps/monitoring/index.md new file mode 100644 index 0000000..1a27594 --- /dev/null +++ b/docs/handbook/infrastructure/apps/monitoring/index.md @@ -0,0 +1,11 @@ +# Monitoring + +!!! 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/apps/monitoring/uptime.md b/docs/handbook/infrastructure/apps/monitoring/uptime.md new file mode 100644 index 0000000..980d4e4 --- /dev/null +++ b/docs/handbook/infrastructure/apps/monitoring/uptime.md @@ -0,0 +1,16 @@ +# Uptime + +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` + + + +--- + +!!! 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 -- 2.43.0 From 68d70fd0ff80b29c56ef9e4eb47a229590cfc2e5 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 16:06:53 -0400 Subject: [PATCH 14/21] Mk PikaPods --- .../providers/servers_and_hosting/pikapods.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/handbook/infrastructure/providers/servers_and_hosting/pikapods.md diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/pikapods.md b/docs/handbook/infrastructure/providers/servers_and_hosting/pikapods.md new file mode 100644 index 0000000..ce5b8e1 --- /dev/null +++ b/docs/handbook/infrastructure/providers/servers_and_hosting/pikapods.md @@ -0,0 +1,18 @@ +# 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. + +## 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 + +## Hosted Apps +- [:octicons-arrow-right-24: Beszel](../../apps/monitoring/beszel.md) +- [:octicons-arrow-right-24: Uptime](../../apps/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. + +--- +!!! 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 -- 2.43.0 From e4f055a0807d5175363ef4088648ae7737b00b3e Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 16:07:11 -0400 Subject: [PATCH 15/21] Upd MXroute connection info --- .../providers/communication/mxroute.md | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/handbook/infrastructure/providers/communication/mxroute.md b/docs/handbook/infrastructure/providers/communication/mxroute.md index e42ce67..3374f7e 100644 --- a/docs/handbook/infrastructure/providers/communication/mxroute.md +++ b/docs/handbook/infrastructure/providers/communication/mxroute.md @@ -2,9 +2,27 @@ [:octicons-link-external-24: MXroute](https://mxroute.com/) hosts our email servers for coporate email, transactional messages, and Postline groups. -## Connection Information -Please see the [:octicons-lock-16: MXroute](https://git.starcat.systems/starcat-internal-docs/infra/wiki/MXroute) page of the internal wiki for connection and access information. +## Servers +List of MXroute servers that we use to run our infrastructure: +`heracles` - our current primary email server +### `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 + +#### Connection Information +IMAP Server: `heracles.mxrouting.net` +SMTP Server: `heracles.mxrouting.net` + +PORTS: +IMAP SSL: `993` +IMAP Non-SSL: `143` +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. --- !!! example "Work in Progress" This page is not complete, and is subject to change. -- 2.43.0 From d0c34fd361b8b0f4115c3137c40366b82479f4d4 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 16:07:36 -0400 Subject: [PATCH 16/21] Upd voip.ms --- .../providers/communication/voipms.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/handbook/infrastructure/providers/communication/voipms.md b/docs/handbook/infrastructure/providers/communication/voipms.md index d441377..800af69 100644 --- a/docs/handbook/infrastructure/providers/communication/voipms.md +++ b/docs/handbook/infrastructure/providers/communication/voipms.md @@ -1,6 +1,21 @@ # Voip.ms [:octicons-link-external-24: 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 + +## 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. + +### 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. + +If you need to set or change your voicemail message for your direct line voicemail box, call in to the main number and enter your voicemail box number. (Or, you can enter your extension and wait for the ringing to stop.) When you reach your own voicemail recording, press the ++*++ (asterisk) key and log in with your voicemail PIN. (Forgot your voicemail box number or PIN? Ask an admin.) + --- !!! example "Work in Progress" This page is not complete, and is subject to change. -- 2.43.0 From 3a4c38bdf66673e4c2f589a08468b1b29c95ec9f Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 16:07:49 -0400 Subject: [PATCH 17/21] Add placeholder for bunny --- .../infrastructure/providers/network/bunny.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/handbook/infrastructure/providers/network/bunny.md b/docs/handbook/infrastructure/providers/network/bunny.md index e668c58..60d897d 100644 --- a/docs/handbook/infrastructure/providers/network/bunny.md +++ b/docs/handbook/infrastructure/providers/network/bunny.md @@ -1 +1,11 @@ -# Bunny \ No newline at end of file +# Bunny + +!!! 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 -- 2.43.0 From aa1668b02a1f63d33b195f4bb12ef5e1f27805e7 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 16:08:06 -0400 Subject: [PATCH 18/21] Add placeholder for NFSN --- .../providers/servers_and_hosting/nfsn.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md b/docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md index eb43262..bc99308 100644 --- a/docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md +++ b/docs/handbook/infrastructure/providers/servers_and_hosting/nfsn.md @@ -1 +1,11 @@ -# NFSN \ No newline at end of file +# NFSN + +!!! 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 -- 2.43.0 From 5f90c5d8e8948d480fc227972ad58eb6c2142706 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 16:08:15 -0400 Subject: [PATCH 19/21] Mk PikaPods --- .../infrastructure/providers/servers_and_hosting/.nav.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml b/docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml index fcc485a..4fd93eb 100644 --- a/docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml +++ b/docs/handbook/infrastructure/providers/servers_and_hosting/.nav.yml @@ -2,4 +2,5 @@ title: Servers + Hosting nav: - index.md - hetzner.md - - nfsn.md \ No newline at end of file + - nfsn.md + - pikapods.md \ No newline at end of file -- 2.43.0 From 54bfcd919e542c8bbbef9e6ad125890597339014 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 16:08:25 -0400 Subject: [PATCH 20/21] Add Apps to Infra --- docs/handbook/infrastructure/.nav.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml index 940cb1d..cfbf1f1 100644 --- a/docs/handbook/infrastructure/.nav.yml +++ b/docs/handbook/infrastructure/.nav.yml @@ -1,5 +1,6 @@ title: Infrastructure nav: - index.md + - apps - providers - naming_conventions.md \ No newline at end of file -- 2.43.0 From d3e28d8e3ec765bca70ba9dff86e463fa674115f Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Fri, 11 Apr 2025 16:13:31 -0400 Subject: [PATCH 21/21] update editing.md --- docs/handbook/meta/editing.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index e1b30c8..aba6bf1 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -1 +1,15 @@ -# Editing this site \ No newline at end of file +# Editing this site + +## Icons +Commonly-used icons for links: +:octicons-arrow-right-24: `:octicons-arrow-right-24:` - 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 + + +--- + +!!! 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 -- 2.43.0