diff --git a/docs/handbook/.nav.yml b/docs/handbook/.nav.yml index e47379d..72fdf54 100644 --- a/docs/handbook/.nav.yml +++ b/docs/handbook/.nav.yml @@ -1,5 +1,4 @@ title: Handbook nav: - index.md - - meta - - infrastructure \ No newline at end of file + - meta \ No newline at end of file diff --git a/docs/handbook/infrastructure/.nav.yml b/docs/handbook/infrastructure/.nav.yml deleted file mode 100644 index 940cb1d..0000000 --- a/docs/handbook/infrastructure/.nav.yml +++ /dev/null @@ -1,5 +0,0 @@ -title: Infrastructure -nav: - - index.md - - providers - - naming_conventions.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/index.md b/docs/handbook/infrastructure/index.md deleted file mode 100644 index 90c21fe..0000000 --- a/docs/handbook/infrastructure/index.md +++ /dev/null @@ -1,2 +0,0 @@ -# Infrastructure -Various things related to the servers, systems, and services that power all StarCat creations. \ No newline at end of file diff --git a/docs/handbook/infrastructure/naming_conventions.md b/docs/handbook/infrastructure/naming_conventions.md deleted file mode 100644 index b80a594..0000000 --- a/docs/handbook/infrastructure/naming_conventions.md +++ /dev/null @@ -1,16 +0,0 @@ -# Naming Conventions -To try and standardize things, aim to use the following naming conventions when assigning server hostnames, etc. - -## Hostnames -Hostnames are assigned as follows: - -``` -env-category-(subservice)-(subdomain) -``` - -- `env`: the environment being hosted. Options are `prod`, `stg`, `dev`, `test` -- `category`: what is being hosted. Options are `pubinfra`, `intinfra`, or a specific product (`sourcecamp`, `casper`, `postline`, etc.) -- `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`) \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/.nav.yml b/docs/handbook/infrastructure/providers/.nav.yml deleted file mode 100644 index 332c48e..0000000 --- a/docs/handbook/infrastructure/providers/.nav.yml +++ /dev/null @@ -1,5 +0,0 @@ -title: Providers -nav: - - index.md - - hetzner.md - - mxroute.md \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/hetzner.md b/docs/handbook/infrastructure/providers/hetzner.md deleted file mode 100644 index 8b5d2ec..0000000 --- a/docs/handbook/infrastructure/providers/hetzner.md +++ /dev/null @@ -1,25 +0,0 @@ -# Hetzner - -[: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 - -## 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. - -**Dedicated**: Server types vary depending on the use-case. - -## Locations -**VPS**: - -- Europe (preferred) - - Primary: `helsinki` - - Secondary: `nuremberg` or `falkenstein` (depending on use-case) -- USA - - Primary: `ashburn` - - Secondary: `hillsboro` - -**Dedicated**: All Hetzner dedicated servers are in Europe, no particularly preferred datacenters. \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/index.md b/docs/handbook/infrastructure/providers/index.md deleted file mode 100644 index 64708b7..0000000 --- a/docs/handbook/infrastructure/providers/index.md +++ /dev/null @@ -1 +0,0 @@ -# Infrastructure Providers \ No newline at end of file diff --git a/docs/handbook/infrastructure/providers/mxroute.md b/docs/handbook/infrastructure/providers/mxroute.md deleted file mode 100644 index 99d476c..0000000 --- a/docs/handbook/infrastructure/providers/mxroute.md +++ /dev/null @@ -1,6 +0,0 @@ -# MXroute - -[:octicons-link-external-24: MXroute](https://mxroute.com/) hosts our email servers for coporate email, transactional messages, and Postline groups. - -## Connection Information -Please see the [:octicons-lock-16: MXroute](https://git.starcat.systems/starcat-internal-docs/infra/wiki/MXroute) page of the internal wiki for connection and access information. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index f053d8b..2ce6ad9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,7 @@ hide: - path --- -# Welcome to StarCat Systems +# Welcome :material-hand-wave: Hello! You've found the 'about' site for [StarCat Systems](https://starcat.systems). This site contains documentation, guides, and other information about our projects and our company.