Skip to content

Commit 82a27a3

Browse files
committed
fixup!: formatting
1 parent ed4c517 commit 82a27a3

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

docs/dogfood/index.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,37 @@
22

33
This guide explains how to [dogfood](https://www.techopedia.com/definition/30784/dogfooding) coder for employees at Coder.
44

5-
## How to
5+
## How to
66

77
The following explains how to do certain things related to dogfooding.
88

99
### Dogfood using Coder's Deployment
1010

11-
1. Go to [https://dev.coder.com/templates/coder-ts](https://dev.coder.com/templates/coder-ts)
12-
1. If you don't have an account, sign in with GitHub
13-
2. If you see a dialog/pop-up, hit "Cancel" (this is because of Rippling)
11+
1. Go to [https://dev.coder.com/templates/coder-ts](https://dev.coder.com/templates/coder-ts)
12+
1. If you don't have an account, sign in with GitHub
13+
2. If you see a dialog/pop-up, hit "Cancel" (this is because of Rippling)
1414
2. Create a workspace
1515
3. [Connect with your favorite IDE](https://coder.com/docs/coder-oss/latest/ides)
16-
4. Clone the repo: `git clone git@github.com:coder/coder.git`
16+
4. Clone the repo: `git clone git@github.com:coder/coder.git`
1717
5. Follow the [contributing guide](https://coder.com/docs/coder-oss/latest/CONTRIBUTING)
1818

1919
### Run Coder in your Coder Workspace
2020

21-
1. Clone the Git repo `[https://github.com/coder/coder](https://github.com/coder/coder)` and `cd` into it
22-
2. Run `sudo apt update` and then `sudo apt install -y netcat`
21+
1. Clone the Git repo `[https://github.com/coder/coder](https://github.com/coder/coder)` and `cd` into it
22+
2. Run `sudo apt update` and then `sudo apt install -y netcat`
2323
- skip this step if using the `coder` template
24-
3. Run `make bin`
25-
24+
3. Run `make bin`
25+
2626
<aside>
2727
💡 If you run into the following error:
28-
28+
2929
```js
3030
pg_dump: server version: 13.7 (Debian 13.7-1.pgdg110+1); pg_dump version: 11.16 (Ubuntu 11.16-1.pgdg20.04+1)
3131
pg_dump: aborting because of server version mismatch
3232
```
33-
33+
3434
Don’t fret! This is a known issue. To get around it:
35-
35+
3636
1. Add `export DB_FROM=coderdb` to your `.bashrc` (make sure you `source ~/.bashrc`)
3737
2. Run `sudo service postgresql start`
3838
3. Run `sudo -u postgres psql` (this will open the PostgreSQL CLI)
@@ -42,24 +42,22 @@ The following explains how to do certain things related to dogfooding.
4242
7. Run `exit` to exit the PostgreSQL terminal
4343
8. Try `make bin` again.
4444
</aside>
45-
46-
4. Run `./scripts/develop.sh` which will start *two* separate processes:
45+
46+
4. Run `./scripts/develop.sh` which will start _two_ separate processes:
4747
1. `[http://localhost:3000](http://localhost:3000)` — backend API server 👈 Backend devs will want to talk to this
4848
2. `[http://localhost:8080](http://localhost:8080)`Node.js dev server 👈 Frontend devs will want to talk to this
49-
50-
5. Ensure that you’re logged in: `./scripts/coder-dev.sh list` — should return no workspace. If this returns an error, double-check the output of running `scripts/develop.sh`.
51-
6. A template named `docker-amd64` (or `docker-arm64` if you’re on ARM) will have automatically been created for you. If you just want to create a workspace quickly, you can run `./scripts/coder-dev.sh create myworkspace -t docker-amd64` and this will get you going quickly!
52-
7. To create your own template, you can do: `./scripts/coder-dev.sh templates init` and choose your preferred option.
53-
For example, choosing “Develop in Docker” will create a new folder `docker` that contains the bare bones for starting a Docker workspace template.
54-
Then, enter the folder that was just created and customize as you wish.
55-
56-
<aside>
57-
💡 **For all Docker templates:**
58-
This step depends on whether you are developing on a Coder v1 workspace, versus a Coder v2 workspace, versus a VM, versus locally. In any case, check the output of the command `docker context ls` to determine where your Docker daemon is listening. Then open `./docker/main.tf` and check inside the block `provider "docker"` that the variable `"host"` is set correctly.
59-
60-
</aside>
49+
5. Ensure that you’re logged in: `./scripts/coder-dev.sh list` — should return no workspace. If this returns an error, double-check the output of running `scripts/develop.sh`.
50+
6. A template named `docker-amd64` (or `docker-arm64` if you’re on ARM) will have automatically been created for you. If you just want to create a workspace quickly, you can run `./scripts/coder-dev.sh create myworkspace -t docker-amd64` and this will get you going quickly!
51+
7. To create your own template, you can do: `./scripts/coder-dev.sh templates init` and choose your preferred option.
52+
For example, choosing “Develop in Docker” will create a new folder `docker` that contains the bare bones for starting a Docker workspace template.
53+
Then, enter the folder that was just created and customize as you wish.
54+
<aside>
55+
💡 **For all Docker templates:**
56+
This step depends on whether you are developing on a Coder v1 workspace, versus a Coder v2 workspace, versus a VM, versus locally. In any case, check the output of the command `docker context ls` to determine where your Docker daemon is listening. Then open `./docker/main.tf` and check inside the block `provider "docker"` that the variable `"host"` is set correctly.
57+
58+
</aside>
6159

62-
## Troubleshooting
60+
## Troubleshooting
6361

6462
### My Docker containers keep failing and I have no idea what's going on!
6563
@@ -86,9 +84,11 @@ Run 'coder create --help' for usage.
8684
```
8785
8886
Check the output of `docker ps -a`
87+
8988
- If you see a container with the status `Exited` run `docker logs <container name>` and see what the issue with the container output is
9089
9190
Enable verbose container logging for Docker:
91+
9292
```shell
9393
sudo cp /etc/docker/daemon.json /etc/docker/daemon.json.orig
9494
sudo cat > /etc/docker/daemon.json << EOF
@@ -98,7 +98,7 @@ sudo cat > /etc/docker/daemon.json << EOF
9898
}
9999
EOF
100100
sudo systemctl restart docker
101-
# You should now see container logs in journald.
101+
# You should now see container logs in journald.
102102
# Try starting a workspace again and see what the actual error is!
103103
sudo journalctl -u docker -f
104104
```

0 commit comments

Comments
 (0)