Skip to content

Commit 15669d5

Browse files
authored
Merge pull request #66 from joshuanianji/automated-documentation-update-11762928506
Automated documentation update
2 parents 0dab53d + dcb74c2 commit 15669d5

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

src/azure-cli-persistence-forked/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
## Options
1515

1616
| Options Id | Description | Type | Default Value |
17-
| ---------- | ----------- | ---- | ------------- |
17+
|-----|-----|-----|-----|
1818

1919

2020
## OS and Architecture Support

src/edgedb-cli/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,21 @@ EdgeDB CLI via the official installation script. Includes the VSCode extension a
2323

2424
- `magicstack.edgedb`
2525

26-
## Note to Users
26+
## Usage
2727

28-
This feature mounts the edgedb config and data folder to the host machine for persistence. To do so, it makes some assumptions about `edgedb info`:
28+
**The EdgeDB instance should not be in the same container as the CLI.** My experience doing so makes the `edgedb ui` command start failing once you restart the container. I recommend the following options:
29+
30+
1. Use a docker-compose template with two services: one for the CLI and one for the EdgeDB instance.
31+
32+
You can either use the [javascript-node-edgedb](https://github.com/joshuanianji/devcontainer-templates/blob/main/src/javascript-node-edgedb) or the [rust-edgedb](https://github.com/joshuanianji/devcontainer-templates/blob/main/src/rust-edgedb) templates, or use them as references to make your own.
33+
34+
Once inside the devcontainer, you can run `edgedb instance link` to connect the CLI to the instance. Check the templates above for more details.
35+
36+
2. Connect to a cloud instance [with `edgedb cloud`](https://docs.edgedb.com/cloud/cli).
37+
38+
## Notes on Volume Mounts
39+
40+
This feature mounts the edgedb config and data folder for persistence. To do so, it makes some assumptions about `edgedb info`:
2941

3042
```bash
3143
$ edgedb info
@@ -40,7 +52,7 @@ EdgeDB uses the following local paths:
4052
└────────────┴────────────────────────────────────────┘
4153
```
4254

43-
**These paths may change based on the OS!**. This feature is tested on Ubuntu and Debian and the paths match up, but may not work for others.
55+
**These paths may change based on the OS!** This feature is tested on Ubuntu and Debian and the paths match up, but may not work for others.
4456

4557
## OS and Architecture Support
4658

src/lamdera/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Installs [Lamdera](https://dashboard.lamdera.app/), a type-safe full-stack web-a
1919

2020
## Lamdera Versions
2121

22-
**Latest tag is hardcoded to v1.1.0!** I'm not sure how to get the latest lamdera version automatically (without web scraping the lamdera site which won't be pretty), so currently this is the solution I have.
22+
**Latest tag is hardcoded to v1.3.0!** I'm not sure how to get the latest lamdera version automatically (without web scraping the lamdera site which won't be pretty), so currently this is the solution I have.
2323

2424
The installation script looks at your OS architecture and version and interpolates it into the following (simplified) command:
2525
```bash
@@ -39,6 +39,7 @@ Shells: `bash`, `zsh`, `fish`
3939

4040
| Version | Notes |
4141
| ------- | ----------------------------- |
42+
| 1.1.0 | Lamdera 1.3.0 |
4243
| 1.0.1 | Fix Docs |
4344
| 1.0.0 | Support zsh/fish and refactor |
4445
| 0.0.2 | Fix typos in Docs |

0 commit comments

Comments
 (0)