diff --git a/README.md b/README.md
index 818a762..11cbbe5 100644
--- a/README.md
+++ b/README.md
@@ -2,20 +2,23 @@
This repo contains the source Markdown and MkDocs files that generate [about.starcat.systems](https://about.starcat.systems) using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
-[](https://git.starcat.systems/starcatsys/about/)
+[)
+](https://git.starcat.systems/starcatsys/about/src/branch/main) [)](https://git.starcat.systems/starcatsys/about/src/branch/staging)
## Contributing
-We welcome your contributions and suggestions! Please see the [Meta](https://about.starcat.systems/handbook/meta/) section of our handbook for contribution and editing information.
+We welcome your contributions and suggestions! Please see the [Editing this site](https://about.starcat.systems/editing/) section of our handbook for contribution and editing information.
-## Code Mirrors
+## Repo Mirrors
-Source code is automatically pushed to the following mirrors.
+Repo contents are automatically pushed to the following mirrors:
-[](https://git.starcat.systems/starcatsys/about/)
+[](https://git.starcat.systems/starcatsys/about/)
-[](https://git.sr.ht/~starcatsys/about)
+[](https://git.sr.ht/~starcatsys/about)
-[](https://gitlab.com/starcatsys-mirror/starcatsys/about)
+[](https://gitlab.com/starcatsys-mirror/starcatsys/about)
-📝 Note that all issues and pull requests should be directed to the [main forge](https://git.starcat.systems/starcatsys/about).
+⚠️ **These mirrors are not routinely monitored.** All issues and pull requests should be directed to the [main forge](https://git.starcat.systems/starcatsys/about/).
+
+*[Why do we mirror some repos?](https://about.starcat.systems/handbook/infrastructure/code/mirroring/)*
\ No newline at end of file
diff --git a/docs/.nav.yml b/docs/.nav.yml
index 16685d4..2241fb8 100644
--- a/docs/.nav.yml
+++ b/docs/.nav.yml
@@ -3,6 +3,7 @@ nav:
- sourcecamp
- docshub
- postline
+ - openhost
- stagelink
- policies
- handbook
diff --git a/docs/about/attribution.md b/docs/about/attribution.md
index 3365e47..291bcf0 100644
--- a/docs/about/attribution.md
+++ b/docs/about/attribution.md
@@ -6,7 +6,16 @@ This site, and all StarCat Systems projects, products, and services make use of
- [`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` repo](https://git.starcat.systems/starcatsys/about) 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.
-- 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/).
+- [`policies` repo](https://git.starcat.systems/starcatsys/policies) icon - adapted from [scroll](https://fontawesome.com/icons/scroll?f=classic&s=solid) by FontAwesome.
+- 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/), [Simple Icons](https://simpleicons.org/), and [OpenMoji](https://openmoji.org/). StarCat product logo icons are attributed elsewhere in this list.
+- StarCat Cloud icon - adapted from [cloud](https://primer.style/octicons/icon/cloud-16/) by [Octicons](https://octicons.github.com/).
- [SourceCamp](https://source.camp) logo - adapted from [camp](https://thenounproject.com/icon/camp-7375488/) by [Ricons](https://thenounproject.com/creator/ricons/) from Noun Project.
- [DocsHub](https://docshub.io) logo - adapted from [Document](https://thenounproject.com/icon/document-6244658/) by [Reion](https://thenounproject.com/creator/dickydante/) from Noun Project.
-- [StageLink](https://stagelink.cloud) logo - adapted from [slider](https://thenounproject.com/icon/slider-2309209/) by [DinosoftLabs](https://thenounproject.com/creator/dinosoftlab/) from Noun Project.
\ No newline at end of file
+- [StageLink](https://stagelink.cloud) logo - adapted from [slider](https://thenounproject.com/icon/slider-2309209/) by [DinosoftLabs](https://thenounproject.com/creator/dinosoftlab/) from Noun Project.
+- [PostLine](https://postline.email) logo - adapted from [Group Mail](https://thenounproject.com/icon/group-mail-1571732/) by [Smashicons](https://thenounproject.com/creator/smashicons/) from Noun Project.
+- [OpenHost](https://openho.st) logo - adapted from [Blockchain](https://thenounproject.com/icon/blockchain-7881143/) by [Hermanto](https://thenounproject.com/creator/kak.her1992/) from Noun Project.
+
+
+## Images
+- [StarCat Systems](https://starcat.systems) landing page background - generated with [Haikei](https://haikei.app/).
+- [StageLink](https://stagelink.cloud) landing page background - generated with [BGJar](https://bgjar.com).
\ No newline at end of file
diff --git a/docs/about/service_domains.md b/docs/about/service_domains.md
index bdabfb7..752b507 100644
--- a/docs/about/service_domains.md
+++ b/docs/about/service_domains.md
@@ -10,7 +10,6 @@ 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).
@@ -22,6 +21,7 @@ This list helps to ensure that you're only dealing with official, legitimate Sta
- `docshub.io` - the homepage for DocsHub
- `postline.email` - the homepage for Postline
- `stagelink.cloud` - the homepage for StageLink
+- `openho.st` - the homepage for OpenHost
## Hosted Services Subdomains List
!!! warning "Warning: Third Party Content"
@@ -38,4 +38,5 @@ This list helps to ensure that you're only dealing with official, legitimate Sta
- :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
+- `*.connect.stagelink.cloud` (e.g., `example.connect.stagelink.cloud`)
+- `*.openhosted.net` (e.g., `example.openhosted.net`)
\ No newline at end of file
diff --git a/docs/handbook/.nav.yml b/docs/handbook/.nav.yml
index e47379d..473cd25 100644
--- a/docs/handbook/.nav.yml
+++ b/docs/handbook/.nav.yml
@@ -2,4 +2,5 @@ title: Handbook
nav:
- index.md
- meta
- - infrastructure
\ No newline at end of file
+ - infrastructure
+ - branding
\ No newline at end of file
diff --git a/docs/handbook/branding/.nav.yml b/docs/handbook/branding/.nav.yml
new file mode 100644
index 0000000..bfc4c0e
--- /dev/null
+++ b/docs/handbook/branding/.nav.yml
@@ -0,0 +1,6 @@
+title: Branding
+nav:
+ - index.md
+ - starcatsys.md
+ - docshub.md
+ - stagelink.md
\ No newline at end of file
diff --git a/docs/handbook/branding/docshub.md b/docs/handbook/branding/docshub.md
new file mode 100644
index 0000000..c286974
--- /dev/null
+++ b/docs/handbook/branding/docshub.md
@@ -0,0 +1,26 @@
+# DocsHub
+
+## Logo
+[:material-folder-lock: Logos > DocsHub](https://cloud.starcatsys.net/f/1175)
+
+Adapted from [Document](https://thenounproject.com/icon/document-6244658/) by [Reion](https://thenounproject.com/creator/dickydante/) from Noun Project.
+
+## Colors
+### Primary Colors
+**Primary blue**: `#1C76B8`
+
+### Website Colors
+**Background**: `#1C76B8`
+**Logo**: `#FFFFFF`
+**Text**: `#FFFFFFC4`
+**Text highlight-text**: `#000000`
+**Text highlight-surround**: `#FFFF00`
+**Button**: `#FFFF00`
+**Button hover**: `#23A1FC`
+
+## Backgrounds
+### Website Background
+The DocsHub website uses a solid color background.
+
+## Fonts
+The DocsHub logo and [:octicons-tab-external-16: landing page](https://docshub.io) both use *Space Mono* by Colophon Foundry for its primary font: [:octicons-link-external-16: Google Fonts - Space Mono](https://fonts.google.com/specimen/Space+Mono)
\ No newline at end of file
diff --git a/docs/handbook/branding/index.md b/docs/handbook/branding/index.md
new file mode 100644
index 0000000..5676638
--- /dev/null
+++ b/docs/handbook/branding/index.md
@@ -0,0 +1,13 @@
+# Branding
+
+Branding information for the various StarCat Systems projects.
+
+!!! abstract "Placeholder Page"
+ This is a placeholder page. Please see the site navigation for any sub-pages that exist.
+
+---
+
+!!! example "Work in Progress"
+ This page is not complete, and is subject to change.
+
+ Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site.
\ No newline at end of file
diff --git a/docs/handbook/branding/stagelink.md b/docs/handbook/branding/stagelink.md
new file mode 100644
index 0000000..655fc17
--- /dev/null
+++ b/docs/handbook/branding/stagelink.md
@@ -0,0 +1,33 @@
+# StageLink
+
+## Logo
+[:material-folder-lock: Logos > StageLink](https://cloud.starcatsys.net/f/929)
+
+Adapted from [slider](https://thenounproject.com/icon/slider-2309209/) by [DinosoftLabs](https://thenounproject.com/creator/dinosoftlab/) from Noun Project
+
+## Colors
+### Primary Colors
+**Primary**: `#004080`
+**Background**: Center box: `#FEFFFFD9`
+
+### Website Colors
+**Logo**: `#004080`
+**Background**: Center box: `#FEFFFFD9`
+**Text**: `#004080`
+**Button**: `#004080`
+**Button hover**: `#0071FF`
+
+## Backgrounds
+### Website Background
+[:material-folder-lock: Backgrounds > StageLink](https://cloud.starcatsys.net/f/857)
+
+The StageLink [:octicons-tab-external-16: landing page](https://stagelink.cloud) background is generated with [:octicons-link-external-16: BGJar - Polygon Luminary](https://bgjar.com/polygon-luminary).
+
+**Width**: `1920 px`
+**Height**: `1080 px`
+**Background**: Simple, `#FFFFFF`
+**Primary Color**: `#29DAFF`
+**Secondary Color**: `#A7F0FF`
+
+## Fonts
+The StageLink logo and [:octicons-tab-external-16: landing page](https://stagelink.cloud) both use *Roboto* by Christian Robertson, Paratype, Font Bureau for its primary font: [:octicons-link-external-16: Google Fonts - Roboto](https://fonts.google.com/specimen/Roboto)
\ No newline at end of file
diff --git a/docs/handbook/branding/starcatsys.md b/docs/handbook/branding/starcatsys.md
new file mode 100644
index 0000000..18d5850
--- /dev/null
+++ b/docs/handbook/branding/starcatsys.md
@@ -0,0 +1,38 @@
+# StarCat Systems
+
+## Logo
+[:material-folder-lock: Logos > StarCat Systems](https://cloud.starcatsys.net/f/1067)
+
+Adapted from [Cat](https://thenounproject.com/icon/cat-6441095/) by [Md Ahasan Habib](https://thenounproject.com/creator/md_ahasan/) from Noun Project.
+
+## Colors
+### Primary Colors
+**Primary bright blue**: `#00FFFF`
+**Dark background purple**: `#2A0037`
+**Lighter background purple**: `#4A007A`
+
+### Website Colors
+**Logo**: `#00FFFF`
+**Primary text**: `#66D9FF`
+**Link**: `#00FFFF`
+**Link hover**: `#CCFFFF`
+**Footer**: `#33BBFF`
+
+## Backgrounds
+### Website Background
+[:material-folder-lock: Backgrounds > StarCat Systems](https://cloud.starcatsys.net/f/866)
+
+The StarCat Systems [:octicons-tab-external-16: landing page](https://starcat.systems) background is generated with [:octicons-link-external-16: Haikei](https://haikei.app/).
+
+**Style**: Layered Waves
+**Color direction**: Option 3 (dark outer, light inner)
+**Background**: `#2A0037`
+**Wave color 1**: `#9E25F8`
+**Wave color 2**: `#7317B2`
+
+## Fonts
+### Logo Font
+The StarCat Systems logo uses *Exo 2* by Natanael Gama for its primary font: [:octicons-link-external-16: Google Fonts - Exo 2](https://fonts.google.com/specimen/Exo+2)
+
+### Website Font
+The StarCat Systems [:octicons-tab-external-16: landing page](https://starcat.systems) uses *Roboto* by Christian Robertson, Paratype, Font Bureau for its primary font: [:octicons-link-external-16: Google Fonts - Roboto](https://fonts.google.com/specimen/Roboto)
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml
index 0b03573..f9748ff 100644
--- a/docs/handbook/infrastructure/.nav.yml
+++ b/docs/handbook/infrastructure/.nav.yml
@@ -3,6 +3,10 @@ nav:
- index.md
- servers_and_hosting
- network
+ - storage
- communication
- monitoring
- - naming_conventions.md
\ No newline at end of file
+ - code
+ - runbooks.md
+ - naming_conventions.md
+ - file_locations.md
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/code/.nav.yml b/docs/handbook/infrastructure/code/.nav.yml
new file mode 100644
index 0000000..7890f6b
--- /dev/null
+++ b/docs/handbook/infrastructure/code/.nav.yml
@@ -0,0 +1,5 @@
+title: Code
+nav:
+ - index.md
+ - forgejo.md
+ - mirroring.md
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/code/forgejo.md b/docs/handbook/infrastructure/code/forgejo.md
new file mode 100644
index 0000000..23ae221
--- /dev/null
+++ b/docs/handbook/infrastructure/code/forgejo.md
@@ -0,0 +1,14 @@
+# Forgejo
+
+We use a self-hosted Forgejo instance for our Git source code hosting.
+
+**URL**: [:simple-forgejo: git.starcat.systems](https://git.starcat.systems)
+**Homepage**: [:octicons-link-external-16: forgejo.org](https://forgejo.org/)
+**Hosting**: [:octicons-arrow-right-16: Hetzner](../servers_and_hosting/hetzner.md) `HEL`
+
+---
+
+!!! example "Work in Progress"
+ This page is not complete, and is subject to change.
+
+ Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site.
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/code/index.md b/docs/handbook/infrastructure/code/index.md
new file mode 100644
index 0000000..d2d6399
--- /dev/null
+++ b/docs/handbook/infrastructure/code/index.md
@@ -0,0 +1,11 @@
+# Code
+
+!!! abstract "Placeholder Page"
+ This is a placeholder page. Please see the site navigation for any sub-pages that exist.
+
+---
+
+!!! example "Work in Progress"
+ This page is not complete, and is subject to change.
+
+ Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site.
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/code/mirroring.md b/docs/handbook/infrastructure/code/mirroring.md
new file mode 100644
index 0000000..8dfc1af
--- /dev/null
+++ b/docs/handbook/infrastructure/code/mirroring.md
@@ -0,0 +1,7 @@
+# Code Mirroring
+You may notice that some of our Git repos (including the repo with the source for this site) have badges showing that they are mirrored to other Git hosts, such as Sourcehut and GitLab. Why are we mirroring some (but not necessarily all) of our repos?
+
+## Why?
+The short version of *Why?* is that if something breaks, we want to have all the materials we need to fix it quickly. This site, our internal handbook, and our infrastructure repos contain notes, documentation, runbooks, and other helpful files and information about how our infrastructure, apps, and business as a whole are set up.
+
+The easier and faster we can get to all of this information, the easier and faster we can get everything back up and running.
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/file_locations.md b/docs/handbook/infrastructure/file_locations.md
new file mode 100644
index 0000000..c0a4edd
--- /dev/null
+++ b/docs/handbook/infrastructure/file_locations.md
@@ -0,0 +1,10 @@
+# File Locations
+To try and standardize things, aim to store specific files in an appropriate location, so that they can easily be located in the future.
+
+## `docker-compose.yml`
+When using a Docker Compose file on Debian/Ubuntu, make the specific service its own directory in `/srv/`, and put the `docker-compose.yml` file inside that directory.
+
+For example: `/srv/authentik/docker-compose.yml`
+
+## `Caddyfile`
+When using the Caddy web server on Debian/Ubuntu, and when configuring the server using the Caddyfile, store the file in `/etc/caddy/Caddyfile`
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/monitoring/.nav.yml b/docs/handbook/infrastructure/monitoring/.nav.yml
index 10c0e35..4cfcc39 100644
--- a/docs/handbook/infrastructure/monitoring/.nav.yml
+++ b/docs/handbook/infrastructure/monitoring/.nav.yml
@@ -2,4 +2,5 @@ title: Monitoring
nav:
- index.md
- beszel.md
- - uptime.md
\ No newline at end of file
+ - uptime.md
+ - umami.md
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/monitoring/umami.md b/docs/handbook/infrastructure/monitoring/umami.md
new file mode 100644
index 0000000..d4555b9
--- /dev/null
+++ b/docs/handbook/infrastructure/monitoring/umami.md
@@ -0,0 +1,20 @@
+# Umami
+
+Umami is an open-source, privacy-focused web analytics tool that serves as an alternative to Google Analytics. It provides essential insights into website traffic, user behavior, and performance, all while prioritizing data privacy.
+
+Unlike many traditional analytics platforms, Umami does not collect or store personal data, avoiding the need for cookies, and is GDPR and PECR compliant.
+
+Designed to be lightweight and easy to set up, Umami can be self-hosted, giving users full control over their data.
+
+**URL**: [:octicons-tab-external-16: metrics.starcatsys.net](https://metrics.starcatsys.net)
+**Homepage**: [:octicons-link-external-16: umami.is](https://umami.is/)
+**Hosting**: [:octicons-arrow-right-16: PikaPods](../servers_and_hosting/pikapods.md) :flags-eu: `EU`
+
+## Groups
+The `StarCat` group contains the majority of the websites that we monitor.
+
+To get access to this group, please see the notes in the internal handbook, below.
+
+## Additional 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.
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/runbooks.md b/docs/handbook/infrastructure/runbooks.md
new file mode 100644
index 0000000..2137aa9
--- /dev/null
+++ b/docs/handbook/infrastructure/runbooks.md
@@ -0,0 +1,5 @@
+# Runbooks
+
+We have a collection of runbooks for how to manually run, install, and maintain the different services and servers we use.
+
+These runbooks are currently proprietary, and are available in the [:material-book-lock: Internal Handbook: Runbooks](https://internal-handbook.starcatsys.net/runbooks/).
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/storage/.nav.yml b/docs/handbook/infrastructure/storage/.nav.yml
new file mode 100644
index 0000000..7aa06b1
--- /dev/null
+++ b/docs/handbook/infrastructure/storage/.nav.yml
@@ -0,0 +1,4 @@
+title: Storage
+nav:
+ - index.md
+ - nextcloud.md
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/storage/index.md b/docs/handbook/infrastructure/storage/index.md
new file mode 100644
index 0000000..2ff52f3
--- /dev/null
+++ b/docs/handbook/infrastructure/storage/index.md
@@ -0,0 +1,11 @@
+# Storage
+
+!!! abstract "Placeholder Page"
+ This is a placeholder page. Please see the site navigation for any sub-pages that exist.
+
+---
+
+!!! example "Work in Progress"
+ This page is not complete, and is subject to change.
+
+ Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site.
\ No newline at end of file
diff --git a/docs/handbook/infrastructure/storage/nextcloud.md b/docs/handbook/infrastructure/storage/nextcloud.md
new file mode 100644
index 0000000..704d10c
--- /dev/null
+++ b/docs/handbook/infrastructure/storage/nextcloud.md
@@ -0,0 +1,14 @@
+# Nextcloud
+
+We use a Nextcloud instance as our internal "cloud" for file hosting and sharing.
+
+**URL**: [:octicons-tab-external-16: cloud.starcatsys.net](https://cloud.starcatsys.net)
+**Homepage**: [:octicons-link-external-16: nextcloud.com](https://nextcloud.com/)
+**Hosting**: [:octicons-arrow-right-16: Hetzner](../servers_and_hosting/hetzner.md) `FSN`
+
+---
+
+!!! example "Work in Progress"
+ This page is not complete, and is subject to change.
+
+ Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site.
\ No newline at end of file
diff --git a/docs/handbook/meta/.nav.yml b/docs/handbook/meta/.nav.yml
index 9d27d6d..d21ca40 100644
--- a/docs/handbook/meta/.nav.yml
+++ b/docs/handbook/meta/.nav.yml
@@ -2,4 +2,5 @@ title: Meta
nav:
- index.md
- editing.md
- - syntax.md
\ No newline at end of file
+ - syntax.md
+ - custom_icons.md
\ No newline at end of file
diff --git a/docs/handbook/meta/custom_icons.md b/docs/handbook/meta/custom_icons.md
new file mode 100644
index 0000000..4b2c843
--- /dev/null
+++ b/docs/handbook/meta/custom_icons.md
@@ -0,0 +1,25 @@
+# Custom Icons
+Material for MkDocs supports custom icons (for example, for our product logos). Here are some notes and steps on adding these files to this site.
+
+## 0. Start with an svg
+You will need the icon in a square `.svg` file format, with a transparent background. I haven't experimented too much with size, but files up to 1000 x 1000 seem to work fine so far.
+
+## 1. Minify the svg
+So that the image will work with MkDocs' color switching and CSS, we need to remove any embedded colors and cruft from the SVG file.
+
+1. Open [:octicons-link-external-16: SVGOMG Optimize](https://optimize.svgomg.net/)
+2. In the left menu, choose **Open SVG** and upload your SVG file
+3. In the *Global Settings* menu, turn on all the options **except for** `Show original`. Leave the sliders at their default settings.
+4. In the *Features* menu, turn on all the options **except for** `Remove xmlns`.
+5. Use the blue download button to download your newly optimized SVG.
+
+## 2. Add the optimized svg to this repo
+In the `about` repo, add the optimized svg file you just downloaded to the `overrides\.icons\` folder. The category will depend on what kind of icon you're adding. (StarCat product icons go in `logos`, etc.)
+
+## 3. Use your new icon
+If you're using the new icon in a Markdown page, you can use the syntax `-`. So, if the category is `logos` and the icon is `docshub.svg`, your icon syntax would be `icons-docshub`.
+
+## Reference
+For a list of the major custom icons and their syntax, see [:octicons-arrow-right-16: Syntax #Custom Icons](syntax.md#custom-icons).
+
+For the primary documentation on Custom Icons in Material for MkDocs, see [:simple-materialformkdocs: Customization - Additional icons](https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#additional-icons).
\ No newline at end of file
diff --git a/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md b/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md
index 32060d7..4269a8e 100644
--- a/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md
+++ b/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md
@@ -5,7 +5,7 @@
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/src/branch/main/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md).
+This is an example page to show the [:octicons-arrow-right-16: Placeholder Page admonition](../syntax.md#placeholder-page). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about/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
+Typically, you would also place a [:octicons-arrow-right-16: Work in Progress admonition](../syntax.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_admonition.md b/docs/handbook/meta/example_pages/example_wip_admonition.md
index 98cfdd4..452e379 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) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about/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](../syntax.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/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.
diff --git a/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md b/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md
index 50c9ceb..ce5839b 100644
--- a/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md
+++ b/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md
@@ -3,7 +3,7 @@
!!! 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/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md).
+This is an example page to show both the [:octicons-arrow-right-16: Placeholder Page admonition](../syntax.md#placeholder-page) and the [:octicons-arrow-right-16: Work in Progress admonition](../syntax.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/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md).
---
!!! example "Work in Progress"
diff --git a/docs/handbook/meta/syntax.md b/docs/handbook/meta/syntax.md
index 794f544..18396cb 100644
--- a/docs/handbook/meta/syntax.md
+++ b/docs/handbook/meta/syntax.md
@@ -9,7 +9,19 @@ Reference for all available Material for MkDocs icons: [:simple-materialformkdoc
: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
-:material-book-lock: `:material-book-lock:` - used for links to the StarCat Systems internal handbook
+:material-book-lock: `:material-book-lock:` - used for links to the StarCat Systems internal handbook
+:material-folder-lock: `:material-folder-lock:` - used for restricted links to files hosted on StarCat Cloud.
+
+### Custom icons
+There are some custom icons added to this MkDocs instance, for example for StarCat product logos. See [:octicons-arrow-right-16: Custom Icons](custom_icons.md) for more details on adding and using custom icons.
+
+#### Logos
+:logos-starcat-circle: `:logos-starcat-circle:` - StarCat Systems circle logo
+:logos-sourcecamp: `:logos-sourcecamp:` - SourceCamp logo
+:logos-docshub: `:logos-docshub:` - DocsHub logo
+:logos-stagelink: `:logos-stagelink:` - StageLink logo
+:logos-postline: `:logos-postline:` - PostLine logo
+:logos-openhost: `:logos-openhost:` - OpenHost logo
### Coloring icons
You can add a color to an icon by adding the CSS color after the icon, like this:
@@ -30,6 +42,10 @@ Currently, the available configured colors are based off the built-in admonition
:octicons-beaker-16:{ .example-purple } `:octicons-beaker-16:{ .example-purple }`
:octicons-quote-16:{ .quote-grey } `:octicons-quote-16:{ .quote-grey }`
+Additionally, "StarCat blue" is available:
+:logos-starcat-circle:{ .starcat-blue } `:logos-starcat-circle:{ .starcat-blue }`
+:logos-starcat-circle:{ .starcat-paleblue } `:logos-starcat-circle:{ .starcat-paleblue }`
+
: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/src/branch/main/docs/stylesheets/extra.css).
## Admonitions
@@ -84,6 +100,34 @@ Here are some common admonitions, when you might use them, and quick code snippe
### Custom
We've modified a couple of the standard admonitions to mean something a little different on this site.
+#### Deprecated
+For pages that were once accurate, but are either no longer accurate and not being updated, or have become obsolete due to discontinuation, etc. Place this admonition at the top of the page, just below the title.
+
+!!! deprecated "Deprecated"
+ The `deprecated` admonition looks like this.
+
+??? quote "Syntax"
+ Copy and paste at the top of page content:
+ ```
+ !!! deprecated "Deprecated"
+ The contents of this page are deprecated. Do not rely on any information on this page to be accurate, as it is not being updated.
+
+ Please see for the equivalet updated information.
+ ```
+
+#### Page Moved
+If a page has been moved, but you still need to link to the original page location for whatever reason. Remove the content of the page (just cut and paste it to the new location), and leave a blank page with just a title and this admonition, linking to the new page location.
+
+!!! page-moved "Page Moved"
+ This page has been moved to a new location. Please view the relocated page [:octicons-arrow-right-16: here](#).
+
+??? quote "Syntax"
+ Copy and paste at the top of page content:
+ ```
+ !!! page-moved "Page Moved"
+ This page has been moved to a new location. Please view the relocated page [:octicons-arrow-right-16: here](#).
+ ```
+
#### 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.)
diff --git a/docs/index.md b/docs/index.md
index 4335238..3007a32 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -23,7 +23,7 @@ You'll find the following sections of information on this site:
-- :octicons-info-24:{ .lg .middle } **About**
+- :logos-starcat-circle:{ .lg .middle .starcat-paleblue } **About**
---
@@ -31,7 +31,7 @@ You'll find the following sections of information on this site:
[:octicons-arrow-right-16: About](about/index.md)
-- :material-tent:{ .lg .middle } **SourceCamp**
+- :logos-sourcecamp:{ .lg .middle .starcat-paleblue } **SourceCamp**
---
@@ -39,7 +39,7 @@ You'll find the following sections of information on this site:
[:octicons-arrow-right-16: SourceCamp](sourcecamp/index.md)
-- :material-notebook-outline:{ .lg .middle } **DocsHub**
+- :logos-docshub:{ .lg .middle .starcat-paleblue } **DocsHub**
---
@@ -47,7 +47,7 @@ You'll find the following sections of information on this site:
[:octicons-arrow-right-16: DocsHub](docshub/index.md)
-- :material-email-fast-outline:{ .lg .middle } **Postline**
+- :logos-postline:{ .lg .middle .starcat-paleblue } **Postline**
---
@@ -55,7 +55,7 @@ You'll find the following sections of information on this site:
[:octicons-arrow-right-16: Postline](postline/index.md)
-- :octicons-sliders-16:{ .lg .middle } **StageLink**
+- :logos-stagelink:{ .lg .middle .starcat-paleblue } **StageLink**
---
@@ -63,7 +63,15 @@ You'll find the following sections of information on this site:
[:octicons-arrow-right-16: StageLink](stagelink/index.md)
-- :fontawesome-solid-scroll:{ .lg .middle } **Policies**
+- :logos-openhost:{ .lg .middle .starcat-paleblue } **OpenHost**
+
+ ---
+
+ Information about [OpenHost](https://openho.st), managed, fast, and easy open-source app hosting.
+
+ [:octicons-arrow-right-16: OpenHost](openhost/index.md)
+
+- :fontawesome-solid-scroll:{ .lg .middle .starcat-paleblue } **Policies**
---
@@ -71,7 +79,23 @@ You'll find the following sections of information on this site:
[:octicons-arrow-right-16: Policies](policies/index.md)
-- :material-book:{ .lg .middle } **Handbook**
+- :fontawesome-solid-life-ring:{ .lg .middle .starcat-paleblue } **Support**
+
+ ---
+
+ Get assistance with your StarCat Systems product(s).
+
+ [:octicons-arrow-right-16: Support](support/index.md)
+
+- :octicons-mail-16:{ .lg .middle .starcat-paleblue } **Contact**
+
+ ---
+
+ Got a question or an idea? Get in touch with the StarCat Systems team.
+
+ [:octicons-arrow-right-16: Contact](contact/index.md)
+
+- :material-book:{ .lg .middle .starcat-paleblue } **Handbook**
---
diff --git a/docs/openhost/.nav.yml b/docs/openhost/.nav.yml
new file mode 100644
index 0000000..847f664
--- /dev/null
+++ b/docs/openhost/.nav.yml
@@ -0,0 +1,3 @@
+title: OpenHost
+nav:
+ - index.md
\ No newline at end of file
diff --git a/docs/openhost/index.md b/docs/openhost/index.md
new file mode 100644
index 0000000..18f9590
--- /dev/null
+++ b/docs/openhost/index.md
@@ -0,0 +1,11 @@
+# OpenHost
+
+!!! abstract "Placeholder Page"
+ This is a placeholder page. Please see the site navigation for any sub-pages that exist.
+
+---
+
+!!! example "Work in Progress"
+ This page is not complete, and is subject to change.
+
+ Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site.
\ No newline at end of file
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
index c61704b..caf93c7 100644
--- a/docs/stylesheets/extra.css
+++ b/docs/stylesheets/extra.css
@@ -1,3 +1,45 @@
+:root {
+ --md-admonition-icon--deprecated: url('data:image/svg+xml;charset=utf-8,')
+}
+.md-typeset .admonition.deprecated,
+.md-typeset details.deprecated {
+ border-color: rgb(98, 114, 164);
+}
+.md-typeset .deprecated > .admonition-title,
+.md-typeset .deprecated > summary {
+ background-color: rgba(98, 114, 164, 0.1);
+}
+.md-typeset .deprecated > .admonition-title::before,
+.md-typeset .deprecated > summary::before {
+ background-color: rgb(98, 114, 164);
+ -webkit-mask-image: var(--md-admonition-icon--deprecated);
+ mask-image: var(--md-admonition-icon--deprecated);
+}
+
+:root {
+ --md-admonition-icon--page-moved: url('data:image/svg+xml;charset=utf-8,')
+}
+.md-typeset .admonition.page-moved,
+.md-typeset details.page-moved {
+ border-color: rgb(255, 121, 198);
+}
+.md-typeset .page-moved > .admonition-title,
+.md-typeset .page-moved > summary {
+ background-color: rgba(255, 121, 198, 0.1);
+}
+.md-typeset .page-moved > .admonition-title::before,
+.md-typeset .page-moved > summary::before {
+ background-color: rgb(255, 121, 198);
+ -webkit-mask-image: var(--md-admonition-icon--page-moved);
+ mask-image: var(--md-admonition-icon--page-moved);
+}
+
+.starcat-blue {
+ color: #00FFFF;
+ }
+.starcat-paleblue {
+ color: #6FCDDD;
+ }
.note-blue {
color: #448AFF;
}
diff --git a/mkdocs.yml b/mkdocs.yml
index be1d57c..c62eb59 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -2,6 +2,7 @@ site_name: StarCat Systems
site_url: https://about.starcat.systems
theme:
name: material
+ custom_dir: overrides
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
@@ -68,6 +69,9 @@ markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
+ options:
+ custom_icons:
+ - overrides/.icons
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
diff --git a/overrides/.icons/flags/eu.svg b/overrides/.icons/flags/eu.svg
new file mode 100644
index 0000000..c729c33
--- /dev/null
+++ b/overrides/.icons/flags/eu.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/overrides/.icons/flags/finland.svg b/overrides/.icons/flags/finland.svg
new file mode 100644
index 0000000..2b43273
--- /dev/null
+++ b/overrides/.icons/flags/finland.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/overrides/.icons/flags/germany.svg b/overrides/.icons/flags/germany.svg
new file mode 100644
index 0000000..c1c47f5
--- /dev/null
+++ b/overrides/.icons/flags/germany.svg
@@ -0,0 +1,31 @@
+
+
\ No newline at end of file
diff --git a/overrides/.icons/flags/luxembourg.svg b/overrides/.icons/flags/luxembourg.svg
new file mode 100644
index 0000000..beab020
--- /dev/null
+++ b/overrides/.icons/flags/luxembourg.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/overrides/.icons/flags/usa.svg b/overrides/.icons/flags/usa.svg
new file mode 100644
index 0000000..880e3e8
--- /dev/null
+++ b/overrides/.icons/flags/usa.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/overrides/.icons/logos/docshub.svg b/overrides/.icons/logos/docshub.svg
new file mode 100644
index 0000000..988adca
--- /dev/null
+++ b/overrides/.icons/logos/docshub.svg
@@ -0,0 +1,4 @@
+
diff --git a/overrides/.icons/logos/openhost.svg b/overrides/.icons/logos/openhost.svg
new file mode 100644
index 0000000..92a8b0a
--- /dev/null
+++ b/overrides/.icons/logos/openhost.svg
@@ -0,0 +1,3 @@
+
diff --git a/overrides/.icons/logos/postline.svg b/overrides/.icons/logos/postline.svg
new file mode 100644
index 0000000..0d59b13
--- /dev/null
+++ b/overrides/.icons/logos/postline.svg
@@ -0,0 +1,3 @@
+
diff --git a/overrides/.icons/logos/sourcecamp.svg b/overrides/.icons/logos/sourcecamp.svg
new file mode 100644
index 0000000..2ce6244
--- /dev/null
+++ b/overrides/.icons/logos/sourcecamp.svg
@@ -0,0 +1,3 @@
+
diff --git a/overrides/.icons/logos/stagelink.svg b/overrides/.icons/logos/stagelink.svg
new file mode 100644
index 0000000..b490393
--- /dev/null
+++ b/overrides/.icons/logos/stagelink.svg
@@ -0,0 +1,4 @@
+
diff --git a/overrides/.icons/logos/starcat-circle.svg b/overrides/.icons/logos/starcat-circle.svg
new file mode 100644
index 0000000..569d2b8
--- /dev/null
+++ b/overrides/.icons/logos/starcat-circle.svg
@@ -0,0 +1,4 @@
+