Skip to content

Commit 8d513ad

Browse files
committed
update main page
1 parent 5ffd9f8 commit 8d513ad

File tree

4 files changed

+135
-13
lines changed

4 files changed

+135
-13
lines changed

astro.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export default defineConfig({
77
site: 'https://forkspacer.com',
88
integrations: [
99
starlight({
10-
title: 'My Docs',
10+
title: 'Forkspacer',
1111
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/forkspacer' }],
1212
sidebar: [
1313
{

src/assets/forkspacer.png

218 KB
Loading

src/assets/houston.webp

-96.2 KB
Binary file not shown.

src/content/docs/index.mdx

Lines changed: 134 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
2-
title: Welcome to Starlight
3-
description: Get started building your docs site with Starlight.
2+
title: Welcome to Forkspacer
3+
description: Get started building your dev environments with Forkspacer.
44
template: splash
55
hero:
6-
tagline: Congrats on setting up a new Starlight project!
6+
tagline: Forkspacer is a Kubernetes-native tool for orchestrating and managing workspaces with modular environments and automation hooks.
77
image:
8-
file: ../../assets/houston.webp
8+
file: ../../assets/forkspacer.png
9+
910
actions:
1011
- text: Example Guide
11-
link: /docs/guides/example/
12+
link: /guides/example/
1213
icon: right-arrow
1314
---
1415

@@ -17,16 +18,137 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
1718
## Next steps
1819

1920
<CardGrid stagger>
20-
<Card title="Update content" icon="pencil">
21-
Edit `src/content/docs/index.mdx` to see this page change.
21+
<Card title="Create a workspace" icon="pencil">
22+
Create workspaces to connect local or remote Kubernetes clusters and install modules to them. You can hibernate workspaces to sleep or resume the modules installed in them.
23+
```yaml
24+
apiVersion: batch.environment.sh/v1
25+
kind: Workspace
26+
metadata:
27+
name: default
28+
namespace: default
29+
30+
spec:
31+
type: kubernetes
32+
connection:
33+
type: in-cluster
34+
autoHibernation:
35+
enabled: true
36+
schedule: "0 42 18 * * *"
37+
wakeSchedule: "0 42 19 * * *"
38+
```
2239
</Card>
23-
<Card title="Add new content" icon="add-document">
24-
Add Markdown or MDX files to `src/content/docs` to create new pages.
40+
<Card title="Install a module" icon="add-document">
41+
Manage your environments via pre-defined and configurable modules.
42+
```yaml
43+
apiVersion: batch.environment.sh/v1
44+
kind: Module
45+
metadata:
46+
name: redis
47+
namespace: default
48+
spec:
49+
source:
50+
httpURL: https://raw.githubusercontent.com/forkspacer/forkspacer/main/examples/redis.yaml
51+
workspace:
52+
name: default
53+
namespace: default
54+
config:
55+
version: 21.2.7
56+
replicaCount: 0
57+
```
2558
</Card>
26-
<Card title="Configure your site" icon="setting">
27-
Edit your `sidebar` and other config in `astro.config.mjs`.
59+
<Card title="Module examples" icon="setting">
60+
<details>
61+
<summary>Helm redis example</summary>
62+
```yaml
63+
kind: Helm
64+
metadata:
65+
name: redis
66+
version: "1.0.0"
67+
supportedOperatorVersion: ">= 0.0.0, < 1.0.0"
68+
author: "platform-team"
69+
description: "Redis in-memory data store"
70+
category: "database"
71+
72+
config:
73+
- type: option
74+
name: "Redis Version"
75+
alias: "version"
76+
spec:
77+
editable: true
78+
required: false
79+
default: "21.2.9"
80+
values:
81+
- "21.2.9"
82+
- "21.2.7"
83+
- "21.2.6"
84+
85+
- type: integer
86+
name: "Replica Count"
87+
alias: "replicaCount"
88+
spec:
89+
editable: true
90+
required: false
91+
default: 1
92+
min: 0
93+
max: 5
94+
95+
spec:
96+
namespace: default
97+
repo: https://charts.bitnami.com/bitnami
98+
chartName: redis
99+
version: "{{.config.version}}"
100+
101+
values:
102+
- raw:
103+
replica:
104+
replicaCount: "{{.config.replicaCount}}"
105+
106+
outputs:
107+
- name: "Redis Password"
108+
valueFrom:
109+
secret:
110+
name: "{{.releaseName}}"
111+
key: redis-password
112+
namespace: default
113+
- name: "Redis Port"
114+
value: 6379
115+
116+
cleanup:
117+
removeNamespace: false
118+
removePVCs: true
119+
```
120+
</details>
121+
122+
<details>
123+
<summary>Custom module example</summary>
124+
```yaml
125+
kind: Custom
126+
metadata:
127+
name: test
128+
version: "1.0.0"
129+
supportedOperatorVersion: ">= 0.0.0, < 1.0.0"
130+
author: "platform-team"
131+
description: "Test"
132+
category: "database"
133+
134+
config:
135+
- type: integer
136+
name: "Disk Size"
137+
alias: "diskSize"
138+
spec:
139+
editable: true
140+
required: false
141+
default: 10
142+
min: 10
143+
max: 50
144+
145+
spec:
146+
repo:
147+
file: "https://example.com/plugin.so"
148+
```
149+
</details>
28150
</Card>
29151
<Card title="Read the docs" icon="open-book">
30-
Learn more in [the Starlight Docs](https://starlight.astro.build/).
152+
Learn more in [the Forkspacer Docs](/docs/guides/example/).
31153
</Card>
32154
</CardGrid>

0 commit comments

Comments
 (0)