Merge pull request #73 from joshuanianji/automated-documentation-update-14125098335

Automated documentation update

Author: joshuanianji

src/edgedb-cli/README.md

@@ -1,3 +1,5 @@
+### **IMPORTANT NOTE**
+- **This Feature is deprecated, and will no longer receive any further updates/support.**
 
 # EdgeDB (edgedb-cli)
 
@@ -23,6 +25,10 @@ EdgeDB CLI via the official installation script. Includes the VSCode extension a
 
 - `magicstack.edgedb`
 
+## Deprecation Notes
+
+Please use [joshuanianji/gel-cli](https://github.com/joshuanianji/devcontainer-features/tree/main/src/gel-cli) instead. See: [EdgeDB is now Gel and Postgres is the Future](https://www.geldata.com/blog/edgedb-is-now-gel-and-postgres-is-the-future)
+
 ## Usage
 
 **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:

src/gel-cli/README.md

@@ -0,0 +1,74 @@
+
+# Gel CLI (gel-cli)
+
+Gel CLI (previously EdgeDB) via the official installation script. Includes the VSCode extension and mounts the config and data folder.
+
+## Example Usage
+
+```json
+"features": {
+    "ghcr.io/joshuanianji/devcontainer-features/gel-cli:1": {}
+}
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+
+
+## Customizations
+
+### VS Code Extensions
+
+- `magicstack.edgedb`
+
+## Usage
+
+**The Gel database instance should not be in the same container as the CLI.** My experience doing so makes the `gel 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 Gel database 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 `gel instance link` to connect the CLI to the instance. Check the templates above for more details.
+
+2. Connect to a cloud instance [with `gel cloud`](https://docs.edgedb.com/cloud/cli).
+
+## Notes on Volume Mounts
+
+This feature mounts the gel config and data folder for persistence. To do so, it makes some assumptions about `gel info`:
+
+```bash
+$ gel info
+
+Gel uses the following local paths:
+┌────────────┬────────────────────────────────────────┐
+│ Cache      │ /home/<user>/.cache/gel/               │
+│ Config     │ /home/<user>/.config/gel/              │
+│ CLI Binary │ /home/<user>/.local/bin/gel            │
+│ Data       │ /home/<user>/.local/share/gel/data/    │
+│ Service    │ /home/<user>/.config/systemd/gel/      │
+└────────────┴────────────────────────────────────────┘
+```
+
+**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
+
+Architectures: `amd` and `arm`
+
+OS: `ubuntu`, `debian`
+
+Shells: `bash`, `zsh`, `fish`
+
+## Changelog
+
+| Version | Notes                                 |
+| ------- | ------------------------------------- |
+| 1.0.0   | Initial Version (migrate from EdgeDB) |
+
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/joshuanianji/devcontainer-features/blob/main/src/gel-cli/devcontainer-feature.json).  Add additional notes to a `NOTES.md`._