Merge from staging #14
42 changed files with 296 additions and 93 deletions
|
|
@ -6,4 +6,5 @@ nav:
|
|||
- stagelink
|
||||
- policies
|
||||
- handbook
|
||||
- support
|
||||
- contact
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -10,8 +10,12 @@ This list helps to ensure that you're only dealing with official, legitimate Sta
|
|||
- `login.starcat.systems` - the StarCat Accounts site. Use your StarCat Account to log in to all other StarCat Services.
|
||||
- :fontawesome-solid-triangle-exclamation:{ .warning-yellow } This is the **only** site that you should enter your StarCat Accounts login information or 2FA information into. All StarCat sites and services will redirect to `login.starcat.systems` for you to log in.
|
||||
- `git.starcat.systems` - the StarCat Git server, powered by Forgejo.
|
||||
- `mantis.starcat.systems` - the StarCat bug and issue tracker, powered by MantisBT.
|
||||
- `policies.starcat.systems` - a quick link that redirects to the Policies section of this site.
|
||||
- `support.starcat.systems` - a quick link that redirects to the Support section of this site.
|
||||
- `status.starcat.systems` - a quick link that redirects to our InStatus offsite status page (below).
|
||||
- `*.starcatsys.net` - a backend domain used to host "under the hood" apps and services. It is unlikely that you would come across this domain.
|
||||
- `starcatsys.instatus.com` - hosts our off-site system status page. Sign up here to receive notifications if we're having issues with any of our systems. (This page redirects from `status.starcat.systems`.)
|
||||
- `starcatsys.instatus.com` - hosts our off-site system status page. Sign up here to receive notifications if we're having issues with any of our systems.
|
||||
|
||||
## StarCat Services Domains List
|
||||
- `source.camp` - the homepage for SourceCamp
|
||||
|
|
|
|||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -1,6 +1,8 @@
|
|||
title: Infrastructure
|
||||
title: Apps + Infrastructure
|
||||
nav:
|
||||
- index.md
|
||||
- apps
|
||||
- providers
|
||||
- servers_and_hosting
|
||||
- network
|
||||
- communication
|
||||
- monitoring
|
||||
- naming_conventions.md
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
title: Apps
|
||||
nav:
|
||||
- index.md
|
||||
- monitoring
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# MXroute
|
||||
|
||||
[:octicons-link-external-24: MXroute](https://mxroute.com/) hosts our email servers for coporate email, transactional messages, and Postline groups.
|
||||
[:octicons-link-external-16: MXroute](https://mxroute.com/) hosts our email servers for coporate email, transactional messages, and Postline groups.
|
||||
|
||||
## Servers
|
||||
List of MXroute servers that we use to run our infrastructure:
|
||||
|
|
@ -8,8 +8,8 @@ List of MXroute servers that we use to run our infrastructure:
|
|||
|
||||
### `heracles`
|
||||
#### Quick Links
|
||||
[:octicons-link-external-24: Control panel](https://heracles.mxrouting.net:2222/) - limited access, contact admin if you need access or need to make changes
|
||||
[:octicons-link-external-24: Basic webmail](https://heracles.mxrouting.net:2222/evo/roundcube) - log in with your full `@starcat.systems` or `@starcatsys.net` email address
|
||||
[:octicons-link-external-16: Control panel](https://heracles.mxrouting.net:2222/) - limited access, contact admin if you need access or need to make changes
|
||||
[:octicons-link-external-16: Basic webmail](https://heracles.mxrouting.net:2222/evo/roundcube) - log in with your full `@starcat.systems` or `@starcatsys.net` email address
|
||||
|
||||
#### Connection Information
|
||||
IMAP Server: `heracles.mxrouting.net`
|
||||
|
|
@ -22,9 +22,11 @@ SMTP SSL: `465`
|
|||
SMTP Non-SSL/STARTTLS: `25` or `587`
|
||||
|
||||
## Additional Information
|
||||
Please see the [:octicons-lock-16: MXroute](https://git.starcat.systems/starcat-internal-docs/infra/wiki/MXroute) for additional configuration and access information.
|
||||
|
||||
Please see the [:material-book-lock: MXroute](https://internal-handbook.starcatsys.net/infrastructure_apps/communication/mxroute/) page of the internal handbook for additional configuration and access information.
|
||||
|
||||
---
|
||||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -1,15 +1,15 @@
|
|||
# Voip.ms
|
||||
[:octicons-link-external-24: Voip.ms](https://voip.ms/) provides phone numbers, calls, and text messages for corporate phone, and app communications.
|
||||
[:octicons-link-external-16: Voip.ms](https://voip.ms/) provides phone numbers, calls, and text messages for corporate phone, and app communications.
|
||||
|
||||
## Quick Links
|
||||
[:octicons-link-external-24: Control panel](https://voip.ms/signin/index.php?ln=en) - limited access, contact admin if you need access or need to make changes
|
||||
[:octicons-link-external-16: Control panel](https://voip.ms/signin/index.php?ln=en) - limited access, contact admin if you need access or need to make changes
|
||||
|
||||
## Current Setup
|
||||
### Incoming Calls
|
||||
When someone calls our main number, the IVR tells them to visit our website for the most efficient support, or they can press ++5++ to leave a voicemail. They can also enter an extension to be forwarded out to a user's direct line, or press ++9++ to have the recording repeated.
|
||||
|
||||
### Outgoing Calls
|
||||
If you need to make an outbound call from our main number, call the main number and press ++7++. Enter the outbound calls passcode (ask admin if you need the passcode), and then follow the prompts to place the call.
|
||||
If you need to make an outbound call from our main number, call the main number and press ++7++. Enter the outbound calls passcode (linked [:material-book-lock: here](https://internal-handbook.starcatsys.net/reference/starcat_meta/phone/#outbound-calls)), and then follow the prompts to place the call.
|
||||
|
||||
### Voicemails
|
||||
By default, all voicemail messages are automatically emailed as an MP3 attachment and deleted from the system. The "Main VM" that incoming callers are directed to from the main menu is emailed to the `voipms_vm_main@starcatsys.net` email group.
|
||||
|
|
@ -20,4 +20,4 @@ If you need to set or change your voicemail message for your direct line voicema
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](../../../meta/editing.md) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -10,4 +10,4 @@ Various things related to the servers, systems, and services that power all Star
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -3,12 +3,12 @@
|
|||
Simple, lightweight server monitoring
|
||||
|
||||
**URL**: [:octicons-tab-external-16: beszel.starcatsys.net](https://beszel.starcatsys.net)
|
||||
**Homepage**: [:octicons-link-external-24: beszel.dev](https://beszel.dev/)
|
||||
**Hosting**: [:octicons-arrow-right-24: PikaPods](../../providers/servers_and_hosting/pikapods.md) `EU`
|
||||
**Homepage**: [:octicons-link-external-16: beszel.dev](https://beszel.dev/)
|
||||
**Hosting**: [:octicons-arrow-right-16: PikaPods](../servers_and_hosting/pikapods.md) `EU`
|
||||
|
||||
---
|
||||
|
||||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -3,8 +3,8 @@
|
|||
Uptime Kuma is an easy-to-use self-hosted monitoring tool.
|
||||
|
||||
**URL**: [:octicons-tab-external-16: uptime.starcatsys.net](https://uptime.starcatsys.net)
|
||||
**Homepage**: [:octicons-link-external-24: louislam/uptime-kuma - GitHub](https://github.com/louislam/uptime-kuma)
|
||||
**Hosting**: [:octicons-arrow-right-24: PikaPods](../../providers/servers_and_hosting/pikapods.md) `EU`
|
||||
**Homepage**: [:octicons-link-external-16: louislam/uptime-kuma - GitHub](https://github.com/louislam/uptime-kuma)
|
||||
**Hosting**: [:octicons-arrow-right-16: PikaPods](../servers_and_hosting/pikapods.md) `EU`
|
||||
|
||||
|
||||
|
||||
|
|
@ -13,4 +13,4 @@ Uptime Kuma is an easy-to-use self-hosted monitoring tool.
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
title: Providers
|
||||
nav:
|
||||
- index.md
|
||||
- servers_and_hosting
|
||||
- network
|
||||
- communication
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# Infrastructure Providers
|
||||
|
||||
!!! abstract "Placeholder Page"
|
||||
This is a placeholder page. Please see the site navigation for any sub-pages that exist.
|
||||
|
||||
---
|
||||
|
||||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
# NFSN
|
||||
|
||||
!!! abstract "Placeholder Page"
|
||||
This is a placeholder page. Please see the site navigation for any sub-pages that exist.
|
||||
|
||||
---
|
||||
|
||||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -3,9 +3,9 @@
|
|||
[:simple-hetzner: Hetzner](https://www.hetzner.com/) hosts the majority of our servers, both virtual and physical.
|
||||
|
||||
## Quick Links
|
||||
[:octicons-link-external-24: Cloud console login](https://console.hetzner.cloud/) - VPS management
|
||||
[:octicons-link-external-24: Robot console login](https://robot.hetzner.com/) - dedicated server management
|
||||
[:octicons-link-external-24: Billing console login](https://accounts.hetzner.com/invoice) - billing and invoice information
|
||||
[:octicons-link-external-16: Cloud console login](https://console.hetzner.cloud/) - VPS management
|
||||
[:octicons-link-external-16: Robot console login](https://robot.hetzner.com/) - dedicated server management
|
||||
[:octicons-link-external-16: Billing console login](https://accounts.hetzner.com/invoice) - billing and invoice information
|
||||
|
||||
## Server Types
|
||||
**VPS**: Typically we use `CAX` series servers when we can use an ARM processor. If we need an x86 processor, we usually use `CX` or `CPX` servies servers.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
18
docs/handbook/infrastructure/servers_and_hosting/nfsn.md
Normal file
18
docs/handbook/infrastructure/servers_and_hosting/nfsn.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# NFSN
|
||||
|
||||
[:octicons-link-external-16: NearlyFreeSpeech.Net](https://www.nearlyfreespeech.net) is a web hosting provider that hosts some of our static and dynamic web pages and apps. We also make use of their MySQL hosting.
|
||||
|
||||
## Quick Links
|
||||
[:octicons-link-external-16: Control panel](https://members.nearlyfreespeech.net/login/) - limited access, you **must** have an NFSN login, and be invited to our project(s).
|
||||
[:octicons-link-external-16: phpMyAdmin](https://phpmyadmin.nearlyfreespeech.net/) - web-based MySQL DB access. You will need a personal MySQL login, or get one from the secrets system.
|
||||
|
||||
## Additional Information
|
||||
Please see the [:material-book-lock: NFSN](https://internal-handbook.starcatsys.net/infrastructure_apps/servers_hosting/nfsn/) page of the internal handbook for additional configuration and access information.
|
||||
|
||||
|
||||
---
|
||||
|
||||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -1,12 +1,12 @@
|
|||
# PikaPods
|
||||
[:octicons-link-external-24: PikaPods](https://pikapods.com/) is an open source app hosting provider that we use to host some of our internal apps.
|
||||
[:octicons-link-external-16: PikaPods](https://pikapods.com/) is an open source app hosting provider that we use to host some of our internal apps.
|
||||
|
||||
## Quick Links
|
||||
[:octicons-link-external-24: Control panel](https://www.pikapods.com/pods) - limited access, contact admin if you need access or need to make changes
|
||||
[:octicons-link-external-16: Control panel](https://www.pikapods.com/pods) - limited access, contact admin if you need access or need to make changes
|
||||
|
||||
## Hosted Apps
|
||||
- [:octicons-arrow-right-24: Beszel](../../apps/monitoring/beszel.md)
|
||||
- [:octicons-arrow-right-24: Uptime](../../apps/monitoring/uptime.md)
|
||||
- [:octicons-arrow-right-16: Beszel](../monitoring/beszel.md)
|
||||
- [:octicons-arrow-right-16: Uptime](../monitoring/uptime.md)
|
||||
|
||||
## Regions
|
||||
When it makes sense, host any new pods in the `EU` region, as it places the pod closer to the majority of our services. For our USA hosted services, or in other special situations, pods can also be hosted in the `US` region.
|
||||
|
|
@ -15,4 +15,4 @@ When it makes sense, host any new pods in the `EU` region, as it places the pod
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](../../../meta/editing.md) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -1,15 +1,132 @@
|
|||
# Editing this site
|
||||
|
||||
## Icons
|
||||
Commonly-used icons for links:
|
||||
:octicons-arrow-right-24: `:octicons-arrow-right-24:` - used for links within the wiki
|
||||
:octicons-tab-external-16: `:octicons-tab-external-16:` - used for links outside the wiki, but within StarCat Systems
|
||||
:octicons-link-external-24: `:octicons-link-external-24:` - used for external links to sites not controlled by StarCat Systems
|
||||
This page contains information on editing/making changes to this website.
|
||||
|
||||
## Material for MkDocs
|
||||
This site is written in Markdown and is generated using [:simple-materialformkdocs: Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) Insiders. The source Markdown is stored in the [:simple-forgejo: about_docs Git repo](https://git.starcat.systems/starcatsys/about_docs).
|
||||
|
||||
## Icons
|
||||
Reference for all available Material for MkDocs icons: [:simple-materialformkdocs: Icons, Emojis](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/)
|
||||
|
||||
### Commonly-used icons for links
|
||||
:octicons-arrow-right-16: `:octicons-arrow-right-16:` - used for links within the wiki
|
||||
:octicons-tab-external-16: `:octicons-tab-external-16:` - used for links outside the wiki, but within StarCat Systems
|
||||
:octicons-link-external-16: `:octicons-link-external-16:` - used for external links to sites not controlled by StarCat Systems
|
||||
:material-book-lock: `:material-book-lock:` - used for links to the StarCat Systems internal handbook
|
||||
|
||||
### Coloring icons
|
||||
You can add a color to an icon by adding the CSS color after the icon, like this:
|
||||
:fontawesome-solid-dragon:{ .bug-pink } `:fontawesome-solid-dragon:{ .bug-pink }`
|
||||
|
||||
|
||||
Currently, the available configured colors are based off the built-in admonition colors and icons, as follows:
|
||||
|
||||
:fontawesome-regular-note-sticky:{ .note-blue } `:fontawesome-regular-note-sticky:{ .note-blue }`
|
||||
:octicons-info-16:{ .info-blue } `:octicons-info-16:{ .info-blue }`
|
||||
:octicons-flame-16:{ .tip-teal } `:octicons-flame-16:{ .tip-teal }`
|
||||
:octicons-check-16:{ .success-green } `:octicons-check-16:{ .success-green }`
|
||||
:octicons-question-16:{ .question-green } `:octicons-question-16:{ .question-green }`
|
||||
:octicons-alert-16:{ .warning-yellow } `:octicons-alert-16:{ .warning-yellow }`
|
||||
:octicons-x-circle-16:{ .failure-red } `:octicons-x-circle-16:{ .failure-red }`
|
||||
:octicons-zap-16:{ .danger-red } `:octicons-zap-16:{ .danger-red }`
|
||||
:octicons-bug-16:{ .bug-pink } `:octicons-bug-16:{ .bug-pink }`
|
||||
:octicons-beaker-16:{ .example-purple } `:octicons-beaker-16:{ .example-purple }`
|
||||
:octicons-quote-16:{ .quote-grey } `:octicons-quote-16:{ .quote-grey }`
|
||||
|
||||
:octicons-flame-16:{ .tip-teal } Want to know how these colors work? Check out [:simple-forgejo: the CSS in the source](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/stylesheets/extra.css).
|
||||
|
||||
## Admonitions
|
||||
Reference for using Admonitions: [:simple-materialformkdocs: Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage)
|
||||
|
||||
|
||||
|
||||
### Common Admonition Usage
|
||||
Here are some common admonitions, when you might use them, and quick code snippets that you can paste in.
|
||||
|
||||
!!! note
|
||||
Highlights information that users should take into account, even when skimming.
|
||||
|
||||
|
||||
```
|
||||
!!! note
|
||||
Highlights information that users should take into account, even when skimming.
|
||||
```
|
||||
|
||||
!!! tip
|
||||
Helpful advice for doing things better or more easily.
|
||||
|
||||
```
|
||||
!!! tip
|
||||
Helpful advice for doing things better or more easily.
|
||||
```
|
||||
|
||||
!!! warning
|
||||
Advises about risks or negative outcomes of certain actions.
|
||||
|
||||
```
|
||||
!!! warning
|
||||
Advises about risks or negative outcomes of certain actions.
|
||||
```
|
||||
|
||||
!!! danger
|
||||
Urgent info that needs immediate user attention to avoid problems.
|
||||
|
||||
```
|
||||
!!! danger
|
||||
Urgent info that needs immediate user attention to avoid problems.
|
||||
```
|
||||
|
||||
!!! bug
|
||||
Information about a known bug in a current version. Whenever possible, provide a link to the issue report. Place a link back to the page with this admonition, in the issue report so that the admonition can be removed when the bug is closed.
|
||||
|
||||
```
|
||||
!!! bug
|
||||
Information about a known bug in a current version. Whenever possible, provide a link to the issue report. Place a link back to the page with this admonition, in the issue report so that the admonition can be removed when the bug is closed.
|
||||
```
|
||||
|
||||
### Custom
|
||||
We've modified a couple of the standard admonitions to mean something a little different on this site.
|
||||
|
||||
#### Work in Progress
|
||||
For pages that aren't yet complete, and need revisions (that we know are going to be revised sooner/more frequently than a typical page.)
|
||||
|
||||
Typically, we will put this at the bottom of the page content, with a dividing line between any page content and this admonition.
|
||||
|
||||
Example page with this Work in Progress admonition: [:octicons-arrow-right-16: Example WIP Admonition](example_pages/example_wip_admonition.md)
|
||||
|
||||
??? quote "Syntax"
|
||||
Copy and paste at the bottom of page content:
|
||||
```
|
||||
---
|
||||
|
||||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
```
|
||||
|
||||
|
||||
#### Placeholder Page
|
||||
For pages that are newly created and have no (or very little) content on the page itself. Also used for `index.md` pages in directories that have other contents, but no content on the directory index.
|
||||
|
||||
Example page with the Placeholder Page admonition: [:octicons-arrow-right-16: Example Placeholder Page Admonition](example_pages/example_placeholder_page_admonition.md)
|
||||
|
||||
??? quote "Syntax"
|
||||
Copy and paste at the bottom of page content:
|
||||
```
|
||||
!!! abstract "Placeholder Page"
|
||||
This is a placeholder page. Please see the site navigation for any sub-pages that exist.
|
||||
```
|
||||
|
||||
!!! tip
|
||||
Typically, any page that is marked as a Placeholder Page should also be marked with the **Work in Progress** admonition because they are, by their nature, incomplete.
|
||||
|
||||
Example page with the Placeholder and WIP admonitions: [:octicons-arrow-right-16: Example Placeholder and WIP Admonitions](example_pages/example_wip_placeholder_admonitions.md)
|
||||
Source code that you can quickly copy from when making an index or placeholder page is located [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md).
|
||||
|
||||
---
|
||||
|
||||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# Example page: Placeholder Page admonition
|
||||
|
||||
!!! abstract "Placeholder Page"
|
||||
This is a placeholder page. Please see the site navigation for any sub-pages that exist.
|
||||
|
||||
There might be a little bit of content here, but nothing substantial.
|
||||
|
||||
This is an example page to show the [:octicons-arrow-right-16: Placeholder Page admonition](../editing.md#placeholder-page). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md).
|
||||
|
||||
---
|
||||
Typically, you would also place a [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) on this page, as it is incomplete. For an example of a full Placeholder and WIP page, see [text](example_wip_placeholder_admonitions.md)
|
||||
13
docs/handbook/meta/example_pages/example_wip_admonition.md
Normal file
13
docs/handbook/meta/example_pages/example_wip_admonition.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Example page: WIP admonition
|
||||
This is an example page to show the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_admonition.md).
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere, urna a tristique hendrerit, felis elit viverra diam, vel porta ante dui a nisi. Aenean mattis nibh est, vitae tristique enim pretium et. Maecenas quis purus egestas, rutrum dolor quis, ultricies neque. Vivamus sit amet lectus ligula. Etiam scelerisque leo odio, quis suscipit felis porttitor semper. Integer eu enim vehicula, molestie elit fringilla, porttitor quam. Ut consectetur feugiat tincidunt.
|
||||
|
||||
Morbi tempus pretium nisi vel bibendum. Nam ut faucibus risus, molestie aliquet odio. Sed semper, elit vel pellentesque pretium, dui odio accumsan ligula, vel gravida dui lacus ac arcu. Duis mollis purus vitae erat mattis, et mollis ipsum aliquam. Maecenas ut sagittis metus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Duis et urna eu ex imperdiet pellentesque sit amet quis eros. Nunc hendrerit venenatis odio, id condimentum leo pellentesque in. Cras vestibulum felis sed neque semper, eget dapibus ligula aliquet.
|
||||
|
||||
---
|
||||
|
||||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# Example page: Placeholder Page and WIP admonitions
|
||||
|
||||
!!! abstract "Placeholder Page"
|
||||
This is a placeholder page. Please see the site navigation for any sub-pages that exist.
|
||||
|
||||
This is an example page to show both the [:octicons-arrow-right-16: Placeholder Page admonition](../editing.md#placeholder-page) and the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md).
|
||||
|
||||
---
|
||||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -29,7 +29,7 @@ You'll find the following sections of information on this site:
|
|||
|
||||
Information about [StarCat Systems](https://starcat.systems) and our projects, as a whole.
|
||||
|
||||
[:octicons-arrow-right-24: About](about/index.md)
|
||||
[:octicons-arrow-right-16: About](about/index.md)
|
||||
|
||||
- :material-tent:{ .lg .middle } **SourceCamp**
|
||||
|
||||
|
|
@ -37,7 +37,7 @@ You'll find the following sections of information on this site:
|
|||
|
||||
Information about [SourceCamp](https://starcat.systems), a simple, private Git server host.
|
||||
|
||||
[:octicons-arrow-right-24: SourceCamp](sourcecamp/index.md)
|
||||
[:octicons-arrow-right-16: SourceCamp](sourcecamp/index.md)
|
||||
|
||||
- :material-notebook-outline:{ .lg .middle } **DocsHQ**
|
||||
|
||||
|
|
@ -45,7 +45,7 @@ You'll find the following sections of information on this site:
|
|||
|
||||
Information about [DocsHQ](https://docshq.app), a continuous documentation platform.
|
||||
|
||||
[:octicons-arrow-right-24: DocsHQ](docshq/index.md)
|
||||
[:octicons-arrow-right-16: DocsHQ](docshq/index.md)
|
||||
|
||||
- :material-email-fast-outline:{ .lg .middle } **Postline**
|
||||
|
||||
|
|
@ -53,7 +53,7 @@ You'll find the following sections of information on this site:
|
|||
|
||||
Information about [Postline](https://postline.email), a discussion + announcement list service.
|
||||
|
||||
[:octicons-arrow-right-24: Postline](postline/index.md)
|
||||
[:octicons-arrow-right-16: Postline](postline/index.md)
|
||||
|
||||
- :octicons-sliders-16:{ .lg .middle } **StageLink**
|
||||
|
||||
|
|
@ -61,7 +61,7 @@ You'll find the following sections of information on this site:
|
|||
|
||||
Information about [StageLink](https://stagelink.cloud), a remote AV+ system management platform.
|
||||
|
||||
[:octicons-arrow-right-24: StageLink](stagelink/index.md)
|
||||
[:octicons-arrow-right-16: StageLink](stagelink/index.md)
|
||||
|
||||
- :fontawesome-solid-scroll:{ .lg .middle } **Policies**
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ You'll find the following sections of information on this site:
|
|||
|
||||
The policies and terms you agree to when you use any of our projects.
|
||||
|
||||
[:octicons-arrow-right-24: Policies](policies/index.md)
|
||||
[:octicons-arrow-right-16: Policies](policies/index.md)
|
||||
|
||||
- :material-book:{ .lg .middle } **Handbook**
|
||||
|
||||
|
|
@ -77,12 +77,12 @@ You'll find the following sections of information on this site:
|
|||
|
||||
Documentation and notes about the running of our projects. Take a look behind the scenes!
|
||||
|
||||
[:octicons-arrow-right-24: Handbook](handbook/index.md)
|
||||
[:octicons-arrow-right-16: Handbook](handbook/index.md)
|
||||
|
||||
</div>
|
||||
|
||||
## :octicons-pencil-24: Edit this site
|
||||
Found an error, or have a content suggestion? **You** are welcome to suggest changes to this site! The source material for this site is hosted on our [:simple-forgejo: Git server](https://git.starcat.systems/starcatsys/about_docs). Check out the [:octicons-arrow-right-24: Editing this site](editing.md) section in the Handbook for more information on making changes.
|
||||
Found an error, or have a content suggestion? **You** are welcome to suggest changes to this site! The source material for this site is hosted on our [:simple-forgejo: Git server](https://git.starcat.systems/starcatsys/about_docs). Check out the [:octicons-arrow-right-16: Editing this site](editing.md) section in the Handbook for more information on making changes.
|
||||
|
||||
## :fontawesome-brands-creative-commons: License
|
||||
The contents of this site are licensed under [:fontawesome-brands-creative-commons::fontawesome-brands-creative-commons-by::fontawesome-brands-creative-commons-sa: CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), unless otherwise noted.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
|
|
@ -1,6 +1,33 @@
|
|||
.warning-yellow {
|
||||
color: #FF9100;
|
||||
.note-blue {
|
||||
color: #448AFF;
|
||||
}
|
||||
.info-blue {
|
||||
color: #00B8D4;
|
||||
}
|
||||
.tip-teal {
|
||||
color: #00BFA5;
|
||||
}
|
||||
.success-green {
|
||||
color: #00C853;
|
||||
}
|
||||
.question-green {
|
||||
color: #64DD17;
|
||||
}
|
||||
.warning-yellow {
|
||||
color: #FF9100;
|
||||
}
|
||||
.failure-red {
|
||||
color: #FF5252;
|
||||
}
|
||||
.danger-red {
|
||||
color: #FF1744;
|
||||
}
|
||||
.bug-pink {
|
||||
color: #F50057;
|
||||
}
|
||||
.example-purple {
|
||||
color: #7C4DFF;
|
||||
}
|
||||
.quote-grey {
|
||||
color: #9E9E9E;
|
||||
}
|
||||
3
docs/support/.nav.yml
Normal file
3
docs/support/.nav.yml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
title: Support
|
||||
nav:
|
||||
- index.md
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Apps
|
||||
# Get Support for StarCat Products
|
||||
|
||||
!!! abstract "Placeholder Page"
|
||||
This is a placeholder page. Please see the site navigation for any sub-pages that exist.
|
||||
|
|
@ -8,4 +8,4 @@
|
|||
!!! example "Work in Progress"
|
||||
This page is not complete, and is subject to change.
|
||||
|
||||
Want to help with this page? Please see [:octicons-arrow-right-24: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site.
|
||||
27
mkdocs.yml
27
mkdocs.yml
|
|
@ -21,7 +21,7 @@ theme:
|
|||
favicon: assets/favicon.svg
|
||||
icon:
|
||||
admonition:
|
||||
note: octicons/tag-16
|
||||
note: fontawesome/regular/note-sticky
|
||||
abstract: material/select-multiple
|
||||
info: octicons/info-16
|
||||
tip: octicons/flame-16
|
||||
|
|
@ -44,6 +44,7 @@ theme:
|
|||
- navigation.top
|
||||
# - navigation.footer
|
||||
- header.autohide
|
||||
- content.tooltips
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
|
|
@ -56,9 +57,21 @@ markdown_extensions:
|
|||
- tables
|
||||
- attr_list
|
||||
- md_in_html
|
||||
- abbr
|
||||
- pymdownx.snippets
|
||||
- pymdownx.inlinehilite
|
||||
- footnotes
|
||||
- toc:
|
||||
slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
|
||||
permalink: true
|
||||
permalink_title: Anchor link to this section
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
line_spans: __span
|
||||
pygments_lang_class: true
|
||||
copyright: Copyright © 2025 StarCat Systems. Released under CC BY-SA 4.0
|
||||
extra_css:
|
||||
- stylesheets/extra.css
|
||||
|
|
@ -67,6 +80,18 @@ plugins:
|
|||
enabled: true
|
||||
- search
|
||||
- awesome-nav
|
||||
- privacy:
|
||||
enabled: true
|
||||
cache: false
|
||||
cache_dir: .cache/plugins/privacy
|
||||
log: true
|
||||
assets: false
|
||||
assets_fetch: true
|
||||
assets_fetch_dir: assets/external
|
||||
links: true
|
||||
links_noopener: true
|
||||
links_attr_map:
|
||||
target: _blank
|
||||
- redirects:
|
||||
redirect_maps:
|
||||
'editing.md': 'handbook/meta/editing.md'
|
||||
Loading…
Add table
Add a link
Reference in a new issue