add some pages
This commit is contained in:
parent
a4a53d0f33
commit
782d3ae294
10 changed files with 102 additions and 48 deletions
|
@ -1,25 +1,26 @@
|
||||||
import { defineConfig } from 'astro/config';
|
import { defineConfig } from "astro/config";
|
||||||
import starlight from '@astrojs/starlight';
|
import starlight from "@astrojs/starlight";
|
||||||
|
|
||||||
// https://astro.build/config
|
// https://astro.build/config
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
integrations: [
|
integrations: [
|
||||||
starlight({
|
starlight({
|
||||||
title: 'My Docs',
|
title: "MZWS",
|
||||||
social: {
|
social: {
|
||||||
github: 'https://github.com/withastro/starlight',
|
github: "https://github.com/withastro/starlight",
|
||||||
},
|
},
|
||||||
sidebar: [
|
sidebar: [
|
||||||
{
|
{
|
||||||
label: 'Guides',
|
label: "Apps",
|
||||||
items: [
|
autogenerate: { directory: "apps" },
|
||||||
// Each item here is one entry in the navigation menu.
|
// items: [
|
||||||
{ label: 'Example Guide', slug: 'guides/example' },
|
// // Each item here is one entry in the navigation menu.
|
||||||
],
|
// { label: "Example Guide", slug: "guides/example" },
|
||||||
|
// ],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Reference',
|
label: "Infra",
|
||||||
autogenerate: { directory: 'reference' },
|
autogenerate: { directory: "infra" },
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
}),
|
}),
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 96 KiB |
7
src/content/docs/apps/forgejo.md
Normal file
7
src/content/docs/apps/forgejo.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Forgejo
|
||||||
|
---
|
||||||
|
|
||||||
|
[Forgejo] is a self-hosted git forge.
|
||||||
|
|
||||||
|
[forgejo]: https://forgejo.org/
|
7
src/content/docs/apps/goatcounter.md
Normal file
7
src/content/docs/apps/goatcounter.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Goatcounter
|
||||||
|
---
|
||||||
|
|
||||||
|
[Goatcounter] is a self-hosted analytics.
|
||||||
|
|
||||||
|
[goatcounter]: https://www.goatcounter.com/
|
26
src/content/docs/apps/wakapi.md
Normal file
26
src/content/docs/apps/wakapi.md
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
---
|
||||||
|
title: Wakapi
|
||||||
|
---
|
||||||
|
|
||||||
|
[Wakapi] is an open-source server-side alternative to [WakaTime].
|
||||||
|
The clients are already mostly open-source.
|
||||||
|
|
||||||
|
The server is configured to forward all heartbeats to my upstream wakatime account.
|
||||||
|
|
||||||
|
This service is **public**. It is served by [veil] at https://wakapi.mzhang.io.
|
||||||
|
|
||||||
|
Registration is **NOT** open.
|
||||||
|
|
||||||
|
[wakapi]: https://wakapi.dev/
|
||||||
|
[wakatime]: https://wakatime.com/
|
||||||
|
[veil]: /infra/veil
|
||||||
|
|
||||||
|
## Client configuration
|
||||||
|
|
||||||
|
Make sure the Wakatime configuration file (`$HOME/.wakatime.cfg`) contains this:
|
||||||
|
|
||||||
|
```
|
||||||
|
[settings]
|
||||||
|
api_url = https://wakapi.mzhang.io/api
|
||||||
|
api_key = <api_key>
|
||||||
|
```
|
|
@ -1,11 +0,0 @@
|
||||||
---
|
|
||||||
title: Example Guide
|
|
||||||
description: A guide in my new Starlight docs site.
|
|
||||||
---
|
|
||||||
|
|
||||||
Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
|
|
||||||
Writing a good guide requires thinking about what your users are trying to do.
|
|
||||||
|
|
||||||
## Further reading
|
|
||||||
|
|
||||||
- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
|
|
|
@ -4,11 +4,9 @@ description: Get started building your docs site with Starlight.
|
||||||
template: splash
|
template: splash
|
||||||
hero:
|
hero:
|
||||||
tagline: Congrats on setting up a new Starlight project!
|
tagline: Congrats on setting up a new Starlight project!
|
||||||
image:
|
|
||||||
file: ../../assets/houston.webp
|
|
||||||
actions:
|
actions:
|
||||||
- text: Example Guide
|
- text: Example Guide
|
||||||
link: /guides/example/
|
link: /infra/garage
|
||||||
icon: right-arrow
|
icon: right-arrow
|
||||||
- text: Read the Starlight docs
|
- text: Read the Starlight docs
|
||||||
link: https://starlight.astro.build
|
link: https://starlight.astro.build
|
||||||
|
|
25
src/content/docs/infra/garage.md
Normal file
25
src/content/docs/infra/garage.md
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
---
|
||||||
|
title: Garage
|
||||||
|
---
|
||||||
|
|
||||||
|
[Garage] is a distributed storage service.
|
||||||
|
It powers https://mzhang.io, this site, as well as many of the other apps.
|
||||||
|
|
||||||
|
## Cluster Information
|
||||||
|
|
||||||
|
There are several nodes:
|
||||||
|
|
||||||
|
- **Minihost.** This node probably has the best uptime.
|
||||||
|
- **Zhang.** This node runs in my parents' house.
|
||||||
|
- **Mac.** This node is offline a lot.
|
||||||
|
- **Desktop (Windows).** This runs an unsupported Windows build of garage.
|
||||||
|
|
||||||
|
I have the cluster running on `consistency_mode = "degraded"`.
|
||||||
|
This is because I don't have 2 machines that will stay online consistently yet (this may change when I ask my parents to keep the computer on all the time).
|
||||||
|
On the default setting of consistent, reads will fail, which causes https://mzhang.io to go down whenever there's less than 2 machines online.
|
||||||
|
|
||||||
|
## Administration
|
||||||
|
|
||||||
|
There is an administration interface at http://minihost:3909 (VPN-private).
|
||||||
|
|
||||||
|
[garage]: https://garagehq.deuxfleurs.fr
|
12
src/content/docs/infra/veil.md
Normal file
12
src/content/docs/infra/veil.md
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
---
|
||||||
|
title: Veil
|
||||||
|
---
|
||||||
|
|
||||||
|
> A veil is an article of clothing or hanging cloth that is intended to cover some part of the head or face, or an object of some significance.
|
||||||
|
|
||||||
|
Veil serves as the primary public interface to all of the HTTP servers.
|
||||||
|
It runs [Caddy] under the hood.
|
||||||
|
|
||||||
|
**TODO:** Check the caddy file into version control...
|
||||||
|
|
||||||
|
[caddy]: https://caddyserver.com/
|
|
@ -1,11 +0,0 @@
|
||||||
---
|
|
||||||
title: Example Reference
|
|
||||||
description: A reference page in my new Starlight docs site.
|
|
||||||
---
|
|
||||||
|
|
||||||
Reference pages are ideal for outlining how things work in terse and clear terms.
|
|
||||||
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
|
|
||||||
|
|
||||||
## Further reading
|
|
||||||
|
|
||||||
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework
|
|
Loading…
Reference in a new issue