Skip to content

Commit 281e2c9

Browse files
committed
docs: minor tweaks to getting started
1 parent f14eac4 commit 281e2c9

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

docs/pages/getting-started.mdx

+7-5
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,13 @@ kubectl -n kty rollout status deploy server
9999
```
100100

101101
Once the pod has started up, you'll want to make sure there's an IP address that
102-
can be reached:
102+
can be reached. This will also add `cluster.kty.dev` to your `/etc/hosts` file
103+
so that it is easy to get to the server in the future.
103104

104105
```bash
105-
kubectl -n kty get service server --output=jsonpath='{.status.loadBalancer.ingress[0].ip}'
106+
kubectl -n kty get service server --output=jsonpath='{.status.loadBalancer.ingress[0].ip}' \
107+
| awk '{print $1 " cluster.kty.dev"}' \
108+
| sudo tee -a /etc/hosts
106109
```
107110

108111
<Callout type="warning">
@@ -122,8 +125,7 @@ see what you can do with kty.
122125
## Test it out
123126

124127
```bash
125-
ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 2222 \
126-
me@$(kubectl -n kty get service server --output=jsonpath='{.status.loadBalancer.ingress[0].ip}')
128+
ssh -p 2222 me@cluster.kty.dev
127129
```
128130

129131
## Next Steps
@@ -135,7 +137,7 @@ ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 2222 \
135137
- `scp` some files out of a container:
136138

137139
```bash
138-
scp -P 2222 me@kty.my-cluster.dev:/default/my-pod/etc/hosts /tmp
140+
scp -P 2222 me@cluster.kty.dev:/default/my-pod/etc/hosts /tmp
139141
```
140142

141143
- Check out [usage](/usage) for more information on everything that you can do.

docs/theme.config.tsx

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ const config: DocsThemeConfig = {
1919
project: {
2020
link: 'https://github.com/grampelberg/kty',
2121
},
22+
chat: {
23+
link: 'https://discord.gg/xMuN5csrQs',
24+
},
2225
docsRepositoryBase: 'https://github.com/grampelberg/kty',
2326
footer: {
2427
content: (

0 commit comments

Comments
 (0)