From dcb74c224ba9fc1e7a6951ac547534f62c104798 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sun, 10 Nov 2024 06:34:44 +0000 Subject: [PATCH] Automated documentation update [skip ci] --- src/azure-cli-persistence-forked/README.md | 2 +- src/edgedb-cli/README.md | 18 +++++++++++++++--- src/lamdera/README.md | 3 ++- 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/src/azure-cli-persistence-forked/README.md b/src/azure-cli-persistence-forked/README.md index 1274d10..6cb89ea 100644 --- a/src/azure-cli-persistence-forked/README.md +++ b/src/azure-cli-persistence-forked/README.md @@ -14,7 +14,7 @@ ## Options | Options Id | Description | Type | Default Value | -| ---------- | ----------- | ---- | ------------- | +|-----|-----|-----|-----| ## OS and Architecture Support diff --git a/src/edgedb-cli/README.md b/src/edgedb-cli/README.md index 3298104..6087fa7 100644 --- a/src/edgedb-cli/README.md +++ b/src/edgedb-cli/README.md @@ -23,9 +23,21 @@ EdgeDB CLI via the official installation script. Includes the VSCode extension a - `magicstack.edgedb` -## Note to Users +## Usage -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`: +**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: + +1. Use a docker-compose template with two services: one for the CLI and one for the EdgeDB instance. + + 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. + + Once inside the devcontainer, you can run `edgedb instance link` to connect the CLI to the instance. Check the templates above for more details. + +2. Connect to a cloud instance [with `edgedb cloud`](https://docs.edgedb.com/cloud/cli). + +## Notes on Volume Mounts + +This feature mounts the edgedb config and data folder for persistence. To do so, it makes some assumptions about `edgedb info`: ```bash $ edgedb info @@ -40,7 +52,7 @@ EdgeDB uses the following local paths: └────────────┴────────────────────────────────────────┘ ``` -**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. +**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. ## OS and Architecture Support diff --git a/src/lamdera/README.md b/src/lamdera/README.md index b2a08bc..0a1163a 100644 --- a/src/lamdera/README.md +++ b/src/lamdera/README.md @@ -19,7 +19,7 @@ Installs [Lamdera](https://dashboard.lamdera.app/), a type-safe full-stack web-a ## Lamdera Versions -**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. +**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. The installation script looks at your OS architecture and version and interpolates it into the following (simplified) command: ```bash @@ -39,6 +39,7 @@ Shells: `bash`, `zsh`, `fish` | Version | Notes | | ------- | ----------------------------- | +| 1.1.0 | Lamdera 1.3.0 | | 1.0.1 | Fix Docs | | 1.0.0 | Support zsh/fish and refactor | | 0.0.2 | Fix typos in Docs |