Compare commits
19 commits
8922393fd9
...
1bffb2be87
| Author | SHA1 | Date | |
|---|---|---|---|
1bffb2be87
|
|||
|
a67f992d92
|
|||
|
42b143ec87
|
|||
|
1ac79049b1
|
|||
|
f0299921ff
|
|||
|
ca54fd4f3c
|
|||
|
eda93c36e0
|
|||
|
41d8aba8ea
|
|||
|
87f4612e24
|
|||
|
33f07a696a
|
|||
|
44532072fb
|
|||
|
6e6aa69ba4
|
|||
|
dc2b4ed04a
|
|||
|
fbd4f7930a
|
|||
|
0b2536d90c
|
|||
|
483940d2f3
|
|||
|
6fea06e6ff
|
|||
|
04422a6cac
|
|||
|
6a8105fd68
|
36 changed files with 187 additions and 171 deletions
|
|
@ -2,7 +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/).
|
||||
|
||||
[](https://git.starcat.systems/starcatsys/about_docs/)
|
||||
[](https://git.starcat.systems/starcatsys/about/)
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
@ -18,4 +18,4 @@ Source code is automatically pushed to the following mirrors.
|
|||
|
||||
[](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_docs).
|
||||
📝 Note that all issues and pull requests should be directed to the [main forge](https://git.starcat.systems/starcatsys/about).
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
nav:
|
||||
- about
|
||||
- sourcecamp
|
||||
- docshq
|
||||
- docshub
|
||||
- postline
|
||||
- stagelink
|
||||
- policies
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@ This site, and all StarCat Systems projects, products, and services make use of
|
|||
## Icons
|
||||
- [StarCat Systems](https://starcat.systems) logo - adapted from [Cat](https://thenounproject.com/icon/cat-6441095/) by [Md Ahasan Habib](https://thenounproject.com/creator/md_ahasan/) from Noun Project.
|
||||
- [`about` site](https://about.starcat.systems) favicon - adapted from [Book](https://thenounproject.com/icon/book-6252926/) by [iconpro86](https://thenounproject.com/creator/iconpro86/) from Noun Project.
|
||||
- [`about-docs` repo](https://git.starcat.systems/starcatsys/about_docs) icon - adapted from [Book](https://thenounproject.com/icon/book-1833960/) by [Untashable](https://thenounproject.com/creator/untashable/) from Noun Project.
|
||||
- [`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.
|
||||
- [`starcat-dev` org](https://git.starcat.systems/starcat-dev) icon - adapted from [lab](https://thenounproject.com/icon/lab-4581077/) by [cr9183353](https://thenounproject.com/creator/cr9183353/) from Noun Project.
|
||||
- [Git server](https://git.starcat.systems/) icon - adapted from [Arcticons Thin Line Icons Collection](https://www.svgrepo.com/collection/arcticons-thin-line-icons/) by [Donnnno](https://www.svgrepo.com/author/Donnnno/) and from the StarCat Systems logo, above.
|
||||
- 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/).
|
||||
- [SourceCamp](https://source.camp) logo - adapted from [camp](https://thenounproject.com/icon/camp-7375488/) by [Ricons](https://thenounproject.com/creator/ricons/) from Noun Project.
|
||||
- Icons used on this `about` site are by [Material Design](https://pictogrammers.com/library/mdi/), [FontAwesome](https://fontawesome.com/search?m=free), [Octicons](https://octicons.github.com/), and [Simple Icons](https://simpleicons.org/).
|
||||
- [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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -19,7 +19,7 @@ This list helps to ensure that you're only dealing with official, legitimate Sta
|
|||
|
||||
## StarCat Services Domains List
|
||||
- `source.camp` - the homepage for SourceCamp
|
||||
- `docshq.app` - the homepage for DocsHQ
|
||||
- `docshub.io` - the homepage for DocsHub
|
||||
- `postline.email` - the homepage for Postline
|
||||
- `stagelink.cloud` - the homepage for StageLink
|
||||
|
||||
|
|
@ -32,8 +32,8 @@ This list helps to ensure that you're only dealing with official, legitimate Sta
|
|||
- `*.starcathosted.com` (e.g., `example.starcathosted.com`)
|
||||
- `*.hosted.source.camp` (e.g., `example.hosted.source.camp`)
|
||||
- :octicons-info-16:{ .info-blue } These subdomains host users' Forgejo instances. If you are an owner or user of one of these instances, you should use your Forgejo login information to sign in to Forgejo. Do not use your StarCat Accounts login information.
|
||||
- `*.hosted.docshq.app` (e.g., `example.hosted.docshq.app`)
|
||||
- :octicons-info-16:{ .info-blue } If your DocsHQ site is set to require authentication, you will be redirected to `auth.examplesite.hosted.docshq.app` to log in with your company credentials. Do not use your StarCat Accounts login information.
|
||||
- `*.hosted.docshub.io` (e.g., `example.hosted.docshub.io`)
|
||||
- :octicons-info-16:{ .info-blue } If your DocsHQ site is set to require authentication, you will be redirected to `auth.examplesite.hosted.docshub.io` to log in with your company credentials. Do not use your StarCat Accounts login information.
|
||||
- `lists.postline.email`
|
||||
- :octicons-info-16:{ .info-blue } When you create or subscribe to a Postline list, you will be prompted to create a separate Postline login which will only work with Postline lists. Do not use your StarCat Accounts login information.
|
||||
- `*.dedicated.postline.email` (e.g., `example.dedicated.postline.email`)
|
||||
|
|
|
|||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
title: DocsHQ
|
||||
nav:
|
||||
- index.md
|
||||
3
docs/docshub/.nav.yml
Normal file
3
docs/docshub/.nav.yml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
title: DocsHub
|
||||
nav:
|
||||
- index.md
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# DocsHQ
|
||||
# DocsHub
|
||||
|
||||
!!! 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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -29,4 +29,4 @@ Please see the [:material-book-lock: MXroute](https://internal-handbook.starcats
|
|||
!!! 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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -11,4 +11,4 @@ Simple, lightweight server monitoring
|
|||
!!! 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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -13,4 +13,4 @@ env-category-(subservice)-(subdomain)
|
|||
- `subservice`: optional, used with `pubinfra` and `intinfra`. For shared infrastructure, what service(s) are being hosted. For example, `auth`, `accounts`, `portal`, etc.
|
||||
- `subdomain`: optional, used for specific products. Identifies the specific user's instance that is being hosted.
|
||||
|
||||
So, for the StarCat Systems [:simple-forgejo: Git server](https://git.starcat.systems/starcatsys/about_docs), the hostname is `prod-sourcecamp-starcatsys`. (`env`=`prod`, `category`=`sourcecamp`, `subservice`=empty, `subdomain`=`starcatsys`)
|
||||
So, for the StarCat Systems [:simple-forgejo: Git server](https://git.starcat.systems), the hostname is `prod-sourcecamp-starcatsys`. (`env`=`prod`, `category`=`sourcecamp`, `subservice`=empty, `subdomain`=`starcatsys`)
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -15,4 +15,4 @@ Please see the [:material-book-lock: NFSN](https://internal-handbook.starcatsys.
|
|||
!!! 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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -1,4 +1,5 @@
|
|||
title: Meta
|
||||
nav:
|
||||
- index.md
|
||||
- editing.md
|
||||
- editing.md
|
||||
- syntax.md
|
||||
|
|
@ -2,131 +2,12 @@
|
|||
|
||||
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).
|
||||
## Syntax
|
||||
Please see [:octicons-arrow-right-16: Syntax](syntax.md) for reference on various Material for MkDocs syntax you can use in your Markdown, and specific usage on this site.
|
||||
|
||||
---
|
||||
|
||||
!!! 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.
|
||||
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.
|
||||
|
|
@ -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_docs/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](../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).
|
||||
|
||||
---
|
||||
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)
|
||||
|
|
@ -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_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_admonition.md).
|
||||
This is an example page to show the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about/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.
|
||||
|
||||
|
|
@ -10,4 +10,4 @@ Morbi tempus pretium nisi vel bibendum. Nam ut faucibus risus, molestie 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.
|
||||
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.
|
||||
|
|
@ -3,10 +3,10 @@
|
|||
!!! 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).
|
||||
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).
|
||||
|
||||
---
|
||||
!!! 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.
|
||||
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.
|
||||
|
|
@ -1,11 +1,16 @@
|
|||
# Handbook Meta
|
||||
|
||||
!!! abstract "Placeholder Page"
|
||||
This is a placeholder page. Please see the site navigation for any sub-pages that exist.
|
||||
This Meta section is for information about this `about.starcat.systems` site itself.
|
||||
|
||||
## 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 Git repo](https://git.starcat.systems/starcatsys/about).
|
||||
|
||||
## Editing
|
||||
If you're looking for information about editing this site, please see [:octicons-arrow-right-16: Editing](editing.md). For specific Markdown syntax you can use with Material for MkDocs, please see [:octicons-arrow-right-16: Syntax](syntax.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.
|
||||
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.
|
||||
129
docs/handbook/meta/syntax.md
Normal file
129
docs/handbook/meta/syntax.md
Normal file
|
|
@ -0,0 +1,129 @@
|
|||
# Syntax
|
||||
|
||||
You can find a reference for the syntax used in writing this site in the Material for MkDocs [:simple-materialformkdocs: Reference section](https://squidfunk.github.io/mkdocs-material/reference/). On this particular site, there are some specific syntax point that we use. This page is intended to provide a reference for those specifics.
|
||||
|
||||
## 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/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) 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/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) for this site.
|
||||
|
|
@ -39,13 +39,13 @@ You'll find the following sections of information on this site:
|
|||
|
||||
[:octicons-arrow-right-16: SourceCamp](sourcecamp/index.md)
|
||||
|
||||
- :material-notebook-outline:{ .lg .middle } **DocsHQ**
|
||||
- :material-notebook-outline:{ .lg .middle } **DocsHub**
|
||||
|
||||
---
|
||||
|
||||
Information about [DocsHQ](https://docshq.app), a continuous documentation platform.
|
||||
Information about [DocsHub](https://docshub.io), a continuous documentation platform.
|
||||
|
||||
[:octicons-arrow-right-16: DocsHQ](docshq/index.md)
|
||||
[:octicons-arrow-right-16: DocsHub](docshub/index.md)
|
||||
|
||||
- :material-email-fast-outline:{ .lg .middle } **Postline**
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ You'll find the following sections of information on this site:
|
|||
</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-16: 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). 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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
|
|
@ -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-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.
|
||||
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.
|
||||
Loading…
Add table
Add a link
Reference in a new issue