From 4a569b14c052011306932781e0b7f362f94804d5 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 5 May 2025 12:53:57 -0400 Subject: [PATCH 01/38] Remove Mantis from Service Domains --- docs/about/service_domains.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/about/service_domains.md b/docs/about/service_domains.md index bdabfb7..7b8270b 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). From e483d48dc6074fec3669eb08afe22d6ca33e383d Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 5 May 2025 12:58:11 -0400 Subject: [PATCH 02/38] Reimplement last commit badge in README --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 316bb37..79f7325 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ 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/). +[![Forgejo Last Commit](https://img.shields.io/gitea/last-commit/starcatsys/about?display_timestamp=committer&gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto)](https://git.starcat.systems/starcatsys/about/) ## Contributing From 73351483d19c6409ddfc9ff3499d358b12792ed3 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 5 May 2025 12:59:04 -0400 Subject: [PATCH 03/38] Rename Git Mirror Badges --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 79f7325..6f2d102 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,10 @@ We welcome your contributions and suggestions! Please see the [Meta](https://abo Source code is automatically pushed to the following mirrors. -[![Static Badge](https://img.shields.io/badge/git.starcat.systems-main-green?style=flat&logo=forgejo&logoColor=fff&logoSize=auto)](https://git.starcat.systems/starcatsys/about/) +[![Main Forge Badge](https://img.shields.io/badge/git.starcat.systems-main-green?style=flat&logo=forgejo&logoColor=fff&logoSize=auto)](https://git.starcat.systems/starcatsys/about/) -[![Static Badge](https://img.shields.io/badge/sourcehut-mirror-blue?style=flat&logo=sourcehut&logoColor=fff&logoSize=auto)](https://git.sr.ht/~starcatsys/about) +[![SourceHut Badge](https://img.shields.io/badge/sourcehut-mirror-blue?style=flat&logo=sourcehut&logoColor=fff&logoSize=auto)](https://git.sr.ht/~starcatsys/about) -[![Static Badge](https://img.shields.io/badge/GitLab-mirror-blue?style=flat&logo=gitlab&logoColor=fff&logoSize=auto)](https://gitlab.com/starcatsys-mirror/starcatsys/about) +[![GitLab Badge](https://img.shields.io/badge/GitLab-mirror-blue?style=flat&logo=gitlab&logoColor=fff&logoSize=auto)](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). From 5669e7f3c62366a61af2bf62d2755b81104c5bb4 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 6 May 2025 10:50:57 -0400 Subject: [PATCH 04/38] Meta/Editing: Fix example page links --- .../meta/example_pages/example_placeholder_page_admonition.md | 4 ++-- docs/handbook/meta/example_pages/example_wip_admonition.md | 2 +- .../meta/example_pages/example_wip_placeholder_admonitions.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) 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" From b0638a3d39f3a3b01ffb3a555c45be19f7bf43ac Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 6 May 2025 13:52:08 -0400 Subject: [PATCH 05/38] Add StarCat Cloud icon attribution --- docs/about/attribution.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/about/attribution.md b/docs/about/attribution.md index 3365e47..5a513e6 100644 --- a/docs/about/attribution.md +++ b/docs/about/attribution.md @@ -7,6 +7,7 @@ This site, and all StarCat Systems projects, products, and services make use of - [`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/). +- 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 From 0f9aa18c1ac1871209d0913aa84f3845e24f6823 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 6 May 2025 13:56:56 -0400 Subject: [PATCH 06/38] Add folder lock icon to syntax --- docs/handbook/meta/syntax.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/handbook/meta/syntax.md b/docs/handbook/meta/syntax.md index 794f544..36ab0e9 100644 --- a/docs/handbook/meta/syntax.md +++ b/docs/handbook/meta/syntax.md @@ -9,7 +9,8 @@ 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. ### Coloring icons You can add a color to an icon by adding the CSS color after the icon, like this: From e7b9e3dc32688ee30d142ba0e9903c3ac136cd65 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 6 May 2025 14:35:24 -0400 Subject: [PATCH 07/38] Add storage infra and Nextcloud --- docs/handbook/infrastructure/.nav.yml | 1 + docs/handbook/infrastructure/storage/.nav.yml | 4 ++++ docs/handbook/infrastructure/storage/index.md | 11 +++++++++++ docs/handbook/infrastructure/storage/nextcloud.md | 14 ++++++++++++++ 4 files changed, 30 insertions(+) create mode 100644 docs/handbook/infrastructure/storage/.nav.yml create mode 100644 docs/handbook/infrastructure/storage/index.md create mode 100644 docs/handbook/infrastructure/storage/nextcloud.md diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml index 0b03573..e98c7be 100644 --- a/docs/handbook/infrastructure/.nav.yml +++ b/docs/handbook/infrastructure/.nav.yml @@ -3,6 +3,7 @@ nav: - index.md - servers_and_hosting - network + - storage - communication - monitoring - naming_conventions.md \ 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 From b141e61e5c866ac783c3c8df22357cd98ee795dd Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 6 May 2025 15:00:46 -0400 Subject: [PATCH 08/38] Add backgrounds to attribution --- docs/about/attribution.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/about/attribution.md b/docs/about/attribution.md index 5a513e6..387060e 100644 --- a/docs/about/attribution.md +++ b/docs/about/attribution.md @@ -10,4 +10,9 @@ This site, and all StarCat Systems projects, products, and services make use of - 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. + + +## 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 From 28c403ac851df5854c133498dc9afdf3ddcd7dfd Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 6 May 2025 16:26:15 -0400 Subject: [PATCH 09/38] Add Branding handbook section - StarCat Systems - DocsHub - StageLink --- docs/handbook/.nav.yml | 3 ++- docs/handbook/branding/.nav.yml | 6 +++++ docs/handbook/branding/docshub.md | 26 +++++++++++++++++++ docs/handbook/branding/index.md | 13 ++++++++++ docs/handbook/branding/stagelink.md | 33 ++++++++++++++++++++++++ docs/handbook/branding/starcatsys.md | 38 ++++++++++++++++++++++++++++ 6 files changed, 118 insertions(+), 1 deletion(-) create mode 100644 docs/handbook/branding/.nav.yml create mode 100644 docs/handbook/branding/docshub.md create mode 100644 docs/handbook/branding/index.md create mode 100644 docs/handbook/branding/stagelink.md create mode 100644 docs/handbook/branding/starcatsys.md 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` blue + +### Website Colors +**Background**: `#1C76B8` blue +**Logo**: `#FFFFFF` blue +**Text**: `#FFFFFFC4` blue +**Text highlight-text**: `#000000` blue +**Text highlight-surround**: `#FFFF00` blue +**Button**: `#FFFF00` blue +**Button hover**: `#23A1FC` blue + +## 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` blue +**Background**: Center box: `#FEFFFFD9` blue + +### Website Colors +**Logo**: `#004080` blue +**Background**: Center box: `#FEFFFFD9` blue +**Text**: `#004080` blue +**Button**: `#004080` blue +**Button hover**: `#0071FF` blue + +## 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` blue +**Primary Color**: `#29DAFF` blue +**Secondary Color**: `#A7F0FF` blue + +## 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` blue +**Dark background purple**: `#2A0037` blue +**Lighter background purple**: `#4A007A` blue + +### Website Colors +**Logo**: `#00FFFF` blue +**Primary text**: `#66D9FF` blue +**Link**: `#00FFFF` blue +**Link hover**: `#CCFFFF` blue +**Footer**: `#33BBFF` blue + +## 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` blue +**Wave color 1**: `#9E25F8` blue +**Wave color 2**: `#7317B2` blue + +## 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 From c5a2e65aa9b36c7088a84a26332cd8803c62de16 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 14:01:16 -0400 Subject: [PATCH 10/38] Add main vs staging badges to README --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f2d102..1c3ead8 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ 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/). -[![Forgejo Last Commit](https://img.shields.io/gitea/last-commit/starcatsys/about?display_timestamp=committer&gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto)](https://git.starcat.systems/starcatsys/about/) +[![Forgejo Last Commit (main)](https://img.shields.io/gitea/last-commit/starcatsys/about/main?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(main)) +](https://git.starcat.systems/starcatsys/about/src/branch/main) [![Forgejo Last Commit (staging)](https://img.shields.io/gitea/last-commit/starcatsys/about/staging?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(staging))](https://git.starcat.systems/starcatsys/about/src/branch/staging) ## Contributing From f43a97d24ceefa945bd412f0017c9b2f1d8db5a3 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 14:01:56 -0400 Subject: [PATCH 11/38] Line break between badges --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1c3ead8..e8a438c 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ 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/). [![Forgejo Last Commit (main)](https://img.shields.io/gitea/last-commit/starcatsys/about/main?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(main)) -](https://git.starcat.systems/starcatsys/about/src/branch/main) [![Forgejo Last Commit (staging)](https://img.shields.io/gitea/last-commit/starcatsys/about/staging?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(staging))](https://git.starcat.systems/starcatsys/about/src/branch/staging) +](https://git.starcat.systems/starcatsys/about/src/branch/main) +[![Forgejo Last Commit (staging)](https://img.shields.io/gitea/last-commit/starcatsys/about/staging?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(staging))](https://git.starcat.systems/starcatsys/about/src/branch/staging) ## Contributing From 668d3824e8cda9e67f3dec5c119164e5ed39b029 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 14:02:33 -0400 Subject: [PATCH 12/38] Change back line break --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index e8a438c..be2edbc 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ 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/). [![Forgejo Last Commit (main)](https://img.shields.io/gitea/last-commit/starcatsys/about/main?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(main)) -](https://git.starcat.systems/starcatsys/about/src/branch/main) -[![Forgejo Last Commit (staging)](https://img.shields.io/gitea/last-commit/starcatsys/about/staging?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(staging))](https://git.starcat.systems/starcatsys/about/src/branch/staging) +](https://git.starcat.systems/starcatsys/about/src/branch/main) | [![Forgejo Last Commit (staging)](https://img.shields.io/gitea/last-commit/starcatsys/about/staging?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(staging))](https://git.starcat.systems/starcatsys/about/src/branch/staging) ## Contributing From ddb1f97f58dd90e1eb497be3778f38dff72319c1 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 14:03:04 -0400 Subject: [PATCH 13/38] Remove divider --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index be2edbc..1c3ead8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ 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/). [![Forgejo Last Commit (main)](https://img.shields.io/gitea/last-commit/starcatsys/about/main?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(main)) -](https://git.starcat.systems/starcatsys/about/src/branch/main) | [![Forgejo Last Commit (staging)](https://img.shields.io/gitea/last-commit/starcatsys/about/staging?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(staging))](https://git.starcat.systems/starcatsys/about/src/branch/staging) +](https://git.starcat.systems/starcatsys/about/src/branch/main) [![Forgejo Last Commit (staging)](https://img.shields.io/gitea/last-commit/starcatsys/about/staging?gitea_url=https%3A%2F%2Fgit.starcat.systems&style=flat&logo=git&logoColor=fff&logoSize=auto&label=last%20commit%20(staging))](https://git.starcat.systems/starcatsys/about/src/branch/staging) ## Contributing From a825428d8a5019732913d02029008f90e7e11ed3 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 14:18:32 -0400 Subject: [PATCH 14/38] Update editing information --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1c3ead8..2ce0839 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This repo contains the source Markdown and MkDocs files that generate [about.sta ## 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 From 7cb307379c5c7b773c282b4fe4715e873af986e7 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 14:23:44 -0400 Subject: [PATCH 15/38] Update main forge badge color --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2ce0839..004a659 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ We welcome your contributions and suggestions! Please see the [Editing this site Source code is automatically pushed to the following mirrors. -[![Main Forge Badge](https://img.shields.io/badge/git.starcat.systems-main-green?style=flat&logo=forgejo&logoColor=fff&logoSize=auto)](https://git.starcat.systems/starcatsys/about/) +[![Main Forge Badge](https://img.shields.io/badge/git.starcat.systems-main-4BC61D?style=flat&logo=forgejo&logoColor=fff&logoSize=auto)](https://git.starcat.systems/starcatsys/about/) [![SourceHut Badge](https://img.shields.io/badge/sourcehut-mirror-blue?style=flat&logo=sourcehut&logoColor=fff&logoSize=auto)](https://git.sr.ht/~starcatsys/about) From f95f84ab752d3fd4f98dcc3d3c440ecc23f83ff5 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 14:32:19 -0400 Subject: [PATCH 16/38] Add runbooks page --- docs/handbook/infrastructure/.nav.yml | 1 + docs/handbook/infrastructure/runbooks.md | 5 +++++ 2 files changed, 6 insertions(+) create mode 100644 docs/handbook/infrastructure/runbooks.md diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml index e98c7be..3c5383d 100644 --- a/docs/handbook/infrastructure/.nav.yml +++ b/docs/handbook/infrastructure/.nav.yml @@ -6,4 +6,5 @@ nav: - storage - communication - monitoring + - runbooks.md - naming_conventions.md \ 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..df9f897 --- /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 Internal Handbook: [:material-book-lock: Runbooks](https://internal-handbook.starcatsys.net/runbooks/) \ No newline at end of file From 8190dbe21c19d5930fc8ce6b69bcfcc4431b7413 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 14:41:43 -0400 Subject: [PATCH 17/38] Update runbooks.md --- docs/handbook/infrastructure/runbooks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/handbook/infrastructure/runbooks.md b/docs/handbook/infrastructure/runbooks.md index df9f897..2137aa9 100644 --- a/docs/handbook/infrastructure/runbooks.md +++ b/docs/handbook/infrastructure/runbooks.md @@ -2,4 +2,4 @@ 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 Internal Handbook: [:material-book-lock: Runbooks](https://internal-handbook.starcatsys.net/runbooks/) \ No newline at end of file +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 From 1b2f9efeecc501e721822e7d67a2d72a24c2721a Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 16:06:27 -0400 Subject: [PATCH 18/38] Create file_locations.md --- docs/handbook/infrastructure/file_locations.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/handbook/infrastructure/file_locations.md 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 From 1d03e620cf64e163bcefed7a30e78ba3d11c7ea3 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 16:06:49 -0400 Subject: [PATCH 19/38] Code infra handbook section --- docs/handbook/infrastructure/.nav.yml | 4 +++- docs/handbook/infrastructure/code/.nav.yml | 5 +++++ docs/handbook/infrastructure/code/forgejo.md | 14 ++++++++++++++ docs/handbook/infrastructure/code/index.md | 11 +++++++++++ docs/handbook/infrastructure/code/mirroring.md | 7 +++++++ 5 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 docs/handbook/infrastructure/code/.nav.yml create mode 100644 docs/handbook/infrastructure/code/forgejo.md create mode 100644 docs/handbook/infrastructure/code/index.md create mode 100644 docs/handbook/infrastructure/code/mirroring.md diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml index 3c5383d..f9748ff 100644 --- a/docs/handbook/infrastructure/.nav.yml +++ b/docs/handbook/infrastructure/.nav.yml @@ -6,5 +6,7 @@ nav: - storage - communication - monitoring + - code - runbooks.md - - naming_conventions.md \ No newline at end of file + - naming_conventions.md + - file_locations.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/code/.nav.yml b/docs/handbook/infrastructure/code/.nav.yml new file mode 100644 index 0000000..7890f6b --- /dev/null +++ b/docs/handbook/infrastructure/code/.nav.yml @@ -0,0 +1,5 @@ +title: Code +nav: + - index.md + - forgejo.md + - mirroring.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/code/forgejo.md b/docs/handbook/infrastructure/code/forgejo.md new file mode 100644 index 0000000..23ae221 --- /dev/null +++ b/docs/handbook/infrastructure/code/forgejo.md @@ -0,0 +1,14 @@ +# Forgejo + +We use a self-hosted Forgejo instance for our Git source code hosting. + +**URL**: [:simple-forgejo: git.starcat.systems](https://git.starcat.systems) +**Homepage**: [:octicons-link-external-16: forgejo.org](https://forgejo.org/) +**Hosting**: [:octicons-arrow-right-16: Hetzner](../servers_and_hosting/hetzner.md) `HEL` + +--- + +!!! example "Work in Progress" + This page is not complete, and is subject to change. + + Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/code/index.md b/docs/handbook/infrastructure/code/index.md new file mode 100644 index 0000000..d2d6399 --- /dev/null +++ b/docs/handbook/infrastructure/code/index.md @@ -0,0 +1,11 @@ +# Code + +!!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + +--- + +!!! example "Work in Progress" + This page is not complete, and is subject to change. + + Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about) for this site. \ No newline at end of file diff --git a/docs/handbook/infrastructure/code/mirroring.md b/docs/handbook/infrastructure/code/mirroring.md new file mode 100644 index 0000000..8dfc1af --- /dev/null +++ b/docs/handbook/infrastructure/code/mirroring.md @@ -0,0 +1,7 @@ +# Code Mirroring +You may notice that some of our Git repos (including the repo with the source for this site) have badges showing that they are mirrored to other Git hosts, such as Sourcehut and GitLab. Why are we mirroring some (but not necessarily all) of our repos? + +## Why? +The short version of *Why?* is that if something breaks, we want to have all the materials we need to fix it quickly. This site, our internal handbook, and our infrastructure repos contain notes, documentation, runbooks, and other helpful files and information about how our infrastructure, apps, and business as a whole are set up. + +The easier and faster we can get to all of this information, the easier and faster we can get everything back up and running. \ No newline at end of file From cc0659499655612894ee68eee1b0e3c2c4b58e77 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Wed, 7 May 2025 16:07:00 -0400 Subject: [PATCH 20/38] Repo mirror info tweaks --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 004a659..11cbbe5 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ This repo contains the source Markdown and MkDocs files that generate [about.sta 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: [![Main Forge Badge](https://img.shields.io/badge/git.starcat.systems-main-4BC61D?style=flat&logo=forgejo&logoColor=fff&logoSize=auto)](https://git.starcat.systems/starcatsys/about/) @@ -19,4 +19,6 @@ Source code is automatically pushed to the following mirrors. [![GitLab Badge](https://img.shields.io/badge/GitLab-mirror-blue?style=flat&logo=gitlab&logoColor=fff&logoSize=auto)](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 From 682e5b6bbd77ea9c8c892e9141dded394feb2cc6 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 11:30:35 -0400 Subject: [PATCH 21/38] Add custom icons and flags --- mkdocs.yml | 4 ++++ overrides/.icons/flags/finland.svg | 1 + overrides/.icons/flags/germany.svg | 31 +++++++++++++++++++++++++++ overrides/.icons/flags/luxembourg.svg | 1 + overrides/.icons/flags/usa.svg | 1 + 5 files changed, 38 insertions(+) create mode 100644 overrides/.icons/flags/finland.svg create mode 100644 overrides/.icons/flags/germany.svg create mode 100644 overrides/.icons/flags/luxembourg.svg create mode 100644 overrides/.icons/flags/usa.svg 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/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 From ac7afd56378c3c5f2829ed9b1d15ffefea97d3f3 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 11:30:49 -0400 Subject: [PATCH 22/38] Add attribution for flag emoji and policies repo --- docs/about/attribution.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/about/attribution.md b/docs/about/attribution.md index 387060e..b647811 100644 --- a/docs/about/attribution.md +++ b/docs/about/attribution.md @@ -6,7 +6,8 @@ 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. From bf74be37a7ef60af7a86d0689dc5a0c8b7341f2e Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:42:22 -0400 Subject: [PATCH 23/38] Add StarCat logo icons --- overrides/.icons/logos/docshub.svg | 4 ++++ overrides/.icons/logos/openhosted.svg | 3 +++ overrides/.icons/logos/postline.svg | 3 +++ overrides/.icons/logos/sourcecamp.svg | 3 +++ overrides/.icons/logos/stagelink.svg | 4 ++++ overrides/.icons/logos/starcat-circle.svg | 4 ++++ 6 files changed, 21 insertions(+) create mode 100644 overrides/.icons/logos/docshub.svg create mode 100644 overrides/.icons/logos/openhosted.svg create mode 100644 overrides/.icons/logos/postline.svg create mode 100644 overrides/.icons/logos/sourcecamp.svg create mode 100644 overrides/.icons/logos/stagelink.svg create mode 100644 overrides/.icons/logos/starcat-circle.svg 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/openhosted.svg b/overrides/.icons/logos/openhosted.svg new file mode 100644 index 0000000..92a8b0a --- /dev/null +++ b/overrides/.icons/logos/openhosted.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 @@ + + + + From 6900f7f43cf02215b2c75572980ac875207a02a5 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:42:39 -0400 Subject: [PATCH 24/38] Add info about custom icons to meta --- docs/handbook/meta/.nav.yml | 3 ++- docs/handbook/meta/custom_icons.md | 25 +++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 docs/handbook/meta/custom_icons.md 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 From 633688236305663a4762a4a2de9bce402ae936d2 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:43:07 -0400 Subject: [PATCH 25/38] Add custom icons to syntax info --- docs/handbook/meta/syntax.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/handbook/meta/syntax.md b/docs/handbook/meta/syntax.md index 36ab0e9..4450110 100644 --- a/docs/handbook/meta/syntax.md +++ b/docs/handbook/meta/syntax.md @@ -12,6 +12,17 @@ Reference for all available Material for MkDocs icons: [:simple-materialformkdoc :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-openhosted: `:logos-openhosted:` - OpenHosted logo + ### Coloring icons You can add a color to an icon by adding the CSS color after the icon, like this: :fontawesome-solid-dragon:{ .bug-pink } `:fontawesome-solid-dragon:{ .bug-pink }` From 5b4a0a884555fc29340a9c6bb9fcfc46ab9851e6 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:43:20 -0400 Subject: [PATCH 26/38] Add PostLine and OpenHosted logo attribution --- docs/about/attribution.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/about/attribution.md b/docs/about/attribution.md index b647811..6655495 100644 --- a/docs/about/attribution.md +++ b/docs/about/attribution.md @@ -12,6 +12,8 @@ This site, and all StarCat Systems projects, products, and services make use of - [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. +- [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. +- [OpenHosted](https://openhosted.net) logo - adapted from [Blockchain](https://thenounproject.com/icon/blockchain-7881143/) by [Hermanto](https://thenounproject.com/creator/kak.her1992/) from Noun Project. ## Images From e305c9a8df061b96664bd8dc5b3fea56d114eb84 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 12:57:15 -0400 Subject: [PATCH 27/38] Add deprecated admonition --- docs/handbook/meta/syntax.md | 15 +++++++++++++++ docs/stylesheets/extra.css | 18 ++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/docs/handbook/meta/syntax.md b/docs/handbook/meta/syntax.md index 4450110..6936b38 100644 --- a/docs/handbook/meta/syntax.md +++ b/docs/handbook/meta/syntax.md @@ -96,6 +96,21 @@ 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. + +!!! 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. + ``` + #### 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/stylesheets/extra.css b/docs/stylesheets/extra.css index c61704b..8288ea2 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -1,3 +1,21 @@ +: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); +} + .note-blue { color: #448AFF; } From 76755b810c688f8200c7c697955cdcb3e4a9b5f9 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 13:04:57 -0400 Subject: [PATCH 28/38] Add page-moved admonition --- docs/handbook/meta/syntax.md | 15 ++++++++++++++- docs/stylesheets/extra.css | 18 ++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/handbook/meta/syntax.md b/docs/handbook/meta/syntax.md index 6936b38..6f2a30c 100644 --- a/docs/handbook/meta/syntax.md +++ b/docs/handbook/meta/syntax.md @@ -97,7 +97,7 @@ Here are some common admonitions, when you might use them, and quick code snippe 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. +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. @@ -111,6 +111,19 @@ For pages that were once accurate, but are either no longer accurate and not bei 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/stylesheets/extra.css b/docs/stylesheets/extra.css index 8288ea2..1868549 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -16,6 +16,24 @@ 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); +} + .note-blue { color: #448AFF; } From c3a9d51d0be0ed3ba665bc000d60690748f682b5 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 14:31:54 -0400 Subject: [PATCH 29/38] Add StarCat Blue and PaleBlue icon colors --- docs/handbook/meta/syntax.md | 4 ++++ docs/stylesheets/extra.css | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/docs/handbook/meta/syntax.md b/docs/handbook/meta/syntax.md index 6f2a30c..e62b7a6 100644 --- a/docs/handbook/meta/syntax.md +++ b/docs/handbook/meta/syntax.md @@ -42,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 diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 1868549..caf93c7 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -34,6 +34,12 @@ mask-image: var(--md-admonition-icon--page-moved); } +.starcat-blue { + color: #00FFFF; + } +.starcat-paleblue { + color: #6FCDDD; + } .note-blue { color: #448AFF; } From f133f778c2747637c31b21d1943f9b928b78040b Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 14:32:30 -0400 Subject: [PATCH 30/38] Update index.md Change icon colors, add OpenHosted, Support, Contact cards --- docs/index.md | 38 +++++++++++++++++++++++++++++++------- 1 file changed, 31 insertions(+), 7 deletions(-) diff --git a/docs/index.md b/docs/index.md index 4335238..d4b939d 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-openhosted:{ .lg .middle .starcat-paleblue } **OpenHosted** + + --- + + Information about [OpenHosted](https://openhosted.net), managed, fast, and easy open-source app hosting. + + [:octicons-arrow-right-16: OpenHosted](openhosted/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-mail-16:](support/index.md) + +- :fontawesome-solid-life-ring:{ .lg .middle .starcat-paleblue } **Contact** + + --- + + Get in touch with the StarCat Systems team. + + [:octicons-arrow-right-16: Contact](contaxt/index.md) + +- :material-book:{ .lg .middle .starcat-paleblue } **Handbook** --- From 0f31dca64a777a641308139e6644cf2a19eb3405 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 14:35:23 -0400 Subject: [PATCH 31/38] Add OpenHosted section template --- docs/.nav.yml | 1 + docs/openhosted/.nav.yml | 3 +++ docs/openhosted/index.md | 11 +++++++++++ 3 files changed, 15 insertions(+) create mode 100644 docs/openhosted/.nav.yml create mode 100644 docs/openhosted/index.md diff --git a/docs/.nav.yml b/docs/.nav.yml index 16685d4..211ce50 100644 --- a/docs/.nav.yml +++ b/docs/.nav.yml @@ -3,6 +3,7 @@ nav: - sourcecamp - docshub - postline + - openhosted - stagelink - policies - handbook diff --git a/docs/openhosted/.nav.yml b/docs/openhosted/.nav.yml new file mode 100644 index 0000000..6ca440e --- /dev/null +++ b/docs/openhosted/.nav.yml @@ -0,0 +1,3 @@ +title: OpenHosted +nav: + - index.md \ No newline at end of file diff --git a/docs/openhosted/index.md b/docs/openhosted/index.md new file mode 100644 index 0000000..124245e --- /dev/null +++ b/docs/openhosted/index.md @@ -0,0 +1,11 @@ +# OpenHosted + +!!! 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 From 2e312cfd2c4f87ecea972533d22fa2e7aeb337a8 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 14:36:52 -0400 Subject: [PATCH 32/38] Fix support link and contact icon --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index d4b939d..9ab70b0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -85,9 +85,9 @@ You'll find the following sections of information on this site: Get assistance with your StarCat Systems product(s). - [:octicons-mail-16:](support/index.md) + [:octicons-arrow-right-16: Support](support/index.md) -- :fontawesome-solid-life-ring:{ .lg .middle .starcat-paleblue } **Contact** +- :octicons-mail-16:{ .lg .middle .starcat-paleblue } **Contact** --- From 19a2389758db9be5aff9517a730966106d398ae8 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 14:38:17 -0400 Subject: [PATCH 33/38] Contact block phrasing and link --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9ab70b0..74c29ed 100644 --- a/docs/index.md +++ b/docs/index.md @@ -91,9 +91,9 @@ You'll find the following sections of information on this site: --- - Get in touch with the StarCat Systems team. + Got a question or an idea? Get in touch with the StarCat Systems team. - [:octicons-arrow-right-16: Contact](contaxt/index.md) + [:octicons-arrow-right-16: Contact](contact/index.md) - :material-book:{ .lg .middle .starcat-paleblue } **Handbook** From f765cc74b5b4a3a64a4229562f6d78685cc02c56 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 15:22:58 -0400 Subject: [PATCH 34/38] Rename OpenHost --- docs/.nav.yml | 2 +- docs/openhost/.nav.yml | 3 +++ docs/{openhosted => openhost}/index.md | 2 +- docs/openhosted/.nav.yml | 3 --- 4 files changed, 5 insertions(+), 5 deletions(-) create mode 100644 docs/openhost/.nav.yml rename docs/{openhosted => openhost}/index.md (89%) delete mode 100644 docs/openhosted/.nav.yml diff --git a/docs/.nav.yml b/docs/.nav.yml index 211ce50..2241fb8 100644 --- a/docs/.nav.yml +++ b/docs/.nav.yml @@ -3,7 +3,7 @@ nav: - sourcecamp - docshub - postline - - openhosted + - openhost - stagelink - policies - 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/openhosted/index.md b/docs/openhost/index.md similarity index 89% rename from docs/openhosted/index.md rename to docs/openhost/index.md index 124245e..18f9590 100644 --- a/docs/openhosted/index.md +++ b/docs/openhost/index.md @@ -1,4 +1,4 @@ -# OpenHosted +# OpenHost !!! abstract "Placeholder Page" This is a placeholder page. Please see the site navigation for any sub-pages that exist. diff --git a/docs/openhosted/.nav.yml b/docs/openhosted/.nav.yml deleted file mode 100644 index 6ca440e..0000000 --- a/docs/openhosted/.nav.yml +++ /dev/null @@ -1,3 +0,0 @@ -title: OpenHosted -nav: - - index.md \ No newline at end of file From 1ca55f914ffd6ce4f8f8161dba491a2d1b2658a1 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 15:30:15 -0400 Subject: [PATCH 35/38] Rename OpenHost --- docs/about/attribution.md | 2 +- docs/handbook/meta/syntax.md | 2 +- docs/index.md | 6 +++--- overrides/.icons/logos/{openhosted.svg => openhost.svg} | 0 4 files changed, 5 insertions(+), 5 deletions(-) rename overrides/.icons/logos/{openhosted.svg => openhost.svg} (100%) diff --git a/docs/about/attribution.md b/docs/about/attribution.md index 6655495..291bcf0 100644 --- a/docs/about/attribution.md +++ b/docs/about/attribution.md @@ -13,7 +13,7 @@ This site, and all StarCat Systems projects, products, and services make use of - [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. - [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. -- [OpenHosted](https://openhosted.net) logo - adapted from [Blockchain](https://thenounproject.com/icon/blockchain-7881143/) by [Hermanto](https://thenounproject.com/creator/kak.her1992/) 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 diff --git a/docs/handbook/meta/syntax.md b/docs/handbook/meta/syntax.md index e62b7a6..18396cb 100644 --- a/docs/handbook/meta/syntax.md +++ b/docs/handbook/meta/syntax.md @@ -21,7 +21,7 @@ There are some custom icons added to this MkDocs instance, for example for StarC :logos-docshub: `:logos-docshub:` - DocsHub logo :logos-stagelink: `:logos-stagelink:` - StageLink logo :logos-postline: `:logos-postline:` - PostLine logo -:logos-openhosted: `:logos-openhosted:` - OpenHosted 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: diff --git a/docs/index.md b/docs/index.md index 74c29ed..3007a32 100644 --- a/docs/index.md +++ b/docs/index.md @@ -63,13 +63,13 @@ You'll find the following sections of information on this site: [:octicons-arrow-right-16: StageLink](stagelink/index.md) -- :logos-openhosted:{ .lg .middle .starcat-paleblue } **OpenHosted** +- :logos-openhost:{ .lg .middle .starcat-paleblue } **OpenHost** --- - Information about [OpenHosted](https://openhosted.net), managed, fast, and easy open-source app hosting. + Information about [OpenHost](https://openho.st), managed, fast, and easy open-source app hosting. - [:octicons-arrow-right-16: OpenHosted](openhosted/index.md) + [:octicons-arrow-right-16: OpenHost](openhost/index.md) - :fontawesome-solid-scroll:{ .lg .middle .starcat-paleblue } **Policies** diff --git a/overrides/.icons/logos/openhosted.svg b/overrides/.icons/logos/openhost.svg similarity index 100% rename from overrides/.icons/logos/openhosted.svg rename to overrides/.icons/logos/openhost.svg From c6283ff1afa766903498dc680fb9c8a27b1e21b4 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 15:35:44 -0400 Subject: [PATCH 36/38] Add OpenHost service domains --- docs/about/service_domains.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/about/service_domains.md b/docs/about/service_domains.md index 7b8270b..752b507 100644 --- a/docs/about/service_domains.md +++ b/docs/about/service_domains.md @@ -21,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" @@ -37,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 From c1953c0f51c53765452bd07964be106b72141b73 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 15:48:49 -0400 Subject: [PATCH 37/38] Create eu.svg --- overrides/.icons/flags/eu.svg | 1 + 1 file changed, 1 insertion(+) create mode 100644 overrides/.icons/flags/eu.svg 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 From 0d14069e430c7cff570a427bab08328e53b14ffe Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Tue, 20 May 2025 16:22:07 -0400 Subject: [PATCH 38/38] Create umami.md --- .../infrastructure/monitoring/.nav.yml | 3 ++- .../infrastructure/monitoring/umami.md | 20 +++++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 docs/handbook/infrastructure/monitoring/umami.md 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