Skip to content

Commit

Permalink
docs(usage-examples): Fixed links nix/*_test.nix -> nix/services/*_te…
Browse files Browse the repository at this point in the history
…st.nix
  • Loading branch information
secobarbital authored and shivaraj-bh committed Sep 7, 2024
1 parent e88a852 commit 5e6aba2
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 10 deletions.
9 changes: 4 additions & 5 deletions doc/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ The project repository is structure to make addition of new services easy. Here'

> [!info]
> See <https://github.com/cachix/devenv/tree/main/src/modules/services> for inspiration.
>
>
> If you don't find a new service there, see <https://github.com/NixOS/nixpkgs/tree/master/nixos/modules/services>.
- Create a new file `./nix/<service-name>.nix` file (see [./nix/redis.nix](https://github.com/juspay/services-flake/blob/main/nix/redis.nix) for inspiration)
- Add the service to the list in [./nix/default.nix](https://github.com/juspay/services-flake/blob/main/nix/default.nix).
- Create a new test file `./nix/<service-name>_test.nix` (see [./nix/redis_test.nix](https://github.com/juspay/services-flake/blob/main/nix/redis_test.nix)).
- Create a new file `./nix/services/<service-name>.nix` file (see [./nix/services/redis.nix](https://github.com/juspay/services-flake/blob/main/nix/services/redis.nix) for inspiration)
- Add the service to the list in [./nix/services/default.nix](https://github.com/juspay/services-flake/blob/main/nix/services/default.nix).
- Create a new test file `./nix/services/<service-name>_test.nix` (see [./nix/services/redis_test.nix](https://github.com/juspay/services-flake/blob/main/nix/services/redis_test.nix)).
- Add the test to [./test/flake.nix](https://github.com/juspay/services-flake/blob/main/test/flake.nix).

{#run-service}
Expand Down Expand Up @@ -72,4 +72,3 @@ We use [emanote](https://emanote.srid.ca/) to render our documentation. The sour
```sh
just doc # Or, `cd doc && nix run`
```

2 changes: 1 addition & 1 deletion doc/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/elasticsearch_test.nix>
<https://github.com/juspay/services-flake/blob/main/nix/services/elasticsearch_test.nix>
2 changes: 1 addition & 1 deletion doc/nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/nginx_test.nix>
<https://github.com/juspay/services-flake/blob/main/nix/services/nginx_test.nix>
2 changes: 1 addition & 1 deletion doc/redis-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
Cluster of #[[redis]] nodes.

Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/redis-cluster_test.nix>
<https://github.com/juspay/services-flake/blob/main/nix/services/redis-cluster_test.nix>
2 changes: 1 addition & 1 deletion doc/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/redis_test.nix>
<https://github.com/juspay/services-flake/blob/main/nix/services/redis_test.nix>
2 changes: 1 addition & 1 deletion doc/zookeeper.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/zookeeper_test.nix>
<https://github.com/juspay/services-flake/blob/main/nix/services/zookeeper_test.nix>

0 comments on commit 5e6aba2

Please sign in to comment.