From 67b4741f7b33f669be9d407cce2af2c77712e05c Mon Sep 17 00:00:00 2001 From: Shivaraj B H Date: Wed, 13 Mar 2024 16:05:01 +0530 Subject: [PATCH] docs: (readme) link to `datadir` doc from `cfp`; (index) add guide (#150) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - `Guide` page is not a child of `services-flake` in page: Screenshot 2024-03-13 at 3 54 20 PM - Link to a more detailed datadir documentation in README --- README.md | 4 ++-- doc/index.md | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 88f6966..e6ddefd 100644 --- a/README.md +++ b/README.md @@ -43,9 +43,9 @@ Want to compare with other tools? [Let us know](https://github.com/juspay/servic [^5]: `service-flake` exposes [`process-compose-flake`](https://github.com/Platonic-Systems/process-compose-flake) modules for each service, which can be reused as long as your project is using `flake-parts`. With devenv, decoupling is not possible (nor [prioritized](https://github.com/cachix/devenv/issues/75#issuecomment-1324914551) in future) unless you buy into the whole devenv ecosystem. -## A note on process working directory +## Service data directory -The `dataDir` of these services tend to take *relative* paths, which are usually relative to the project root. As such, when you run these services using `nix run`, their data files are created relative to whichever directory you are in. If you want these data files to always reside relative to the project directory, instead of using `nix run` consider wrapping the process-compose packages in script, via either [mission-control](https://community.flake.parts/mission-control) module or a [justfile](https://just.systems/). The example uses the latter. +See ## Discussions diff --git a/doc/index.md b/doc/index.md index 616164d..9805754 100644 --- a/doc/index.md +++ b/doc/index.md @@ -17,6 +17,7 @@ See: - [[start]]# - [[services]]# - [[contributing]]# +- [[guide]]# ## Demo