docs: create placeholders (#156)

juspay · Mar 20, 2024 · e706d93 · e706d93
1 parent 819ab20
commit e706d93
Show file tree

Hide file tree

Showing 11 changed files with 60 additions and 7 deletions.
diff --git a/doc/apache-kafka.md b/doc/apache-kafka.md
@@ -0,0 +1,6 @@
+# Apache Kafka
+
+>[!warning] 🚧 WIP
+
+Usage example:
+<https://github.com/juspay/services-flake/blob/main/nix/apache-kafka_test.nix>
diff --git a/doc/elasticsearch.md b/doc/elasticsearch.md
@@ -0,0 +1,6 @@
+# Elasticsearch
+
+>[!warning] 🚧 WIP
+
+Usage example:
+<https://github.com/juspay/services-flake/blob/main/nix/elasticsearch_test.nix>
diff --git a/doc/examples.md b/doc/examples.md
@@ -0,0 +1,3 @@
+# Examples
+
+- [ ] [[share-services]]#
diff --git a/doc/index.md b/doc/index.md
@@ -14,7 +14,9 @@ emanote:
 It builds on top of the [process-compose-flake](https://community.flake.parts/process-compose-flake) module which allows running arbitrary processes declared in Nix.
 
 See:
+
 - [[start]]#
+- [[examples]]#
 - [[services]]#
 - [[contributing]]#
 - [[guide]]#

diff --git a/doc/mysql.md b/doc/mysql.md
@@ -0,0 +1,6 @@
+# MySQL
+
+>[!warning] 🚧 WIP
+
+Usage example:
+<https://github.com/juspay/services-flake/blob/main/nix/mysql/mysql_test.nix>
diff --git a/doc/nginx.md b/doc/nginx.md
@@ -0,0 +1,6 @@
+# Nginx
+
+>[!warning] 🚧 WIP
+
+Usage example:
+<https://github.com/juspay/services-flake/blob/main/nix/nginx_test.nix>
diff --git a/doc/redis-cluster.md b/doc/redis-cluster.md
@@ -0,0 +1,6 @@
+# Redis Cluster
+
+>[!warning] 🚧 WIP
+
+Usage example:
+<https://github.com/juspay/services-flake/blob/main/nix/redis-cluster_test.nix>
diff --git a/doc/redis.md b/doc/redis.md
@@ -0,0 +1,6 @@
+# Redis
+
+>[!warning] 🚧 WIP
+
+Usage example:
+<https://github.com/juspay/services-flake/blob/main/nix/redis_test.nix>
diff --git a/doc/services.md b/doc/services.md
@@ -7,16 +7,16 @@ short-title: Services
 >[!warning] WIP
 > Documentation for the services is still in progress. Please refer to [this issue][gh] for progress.
 
-- Apache Kafka
+- [[apache-kafka]]#
 - [[clickhouse]]#
-- Elasticsearch
-- MySQL
-- Nginx
+- [[elasticsearch]]#
+- [[mysql]]#
+- [[nginx]]#
 - [[postgresql]]#
   - [[pgadmin]]
-- Redis
-  - Redis Cluster
-- Zookeeper
+- [[redis]]#
+  - [[redis-cluster]]#
+- [[zookeeper]]#
 - [[grafana]]#
 - [[prometheus]]#
 - [[cassandra]]#

diff --git a/doc/share-services.md b/doc/share-services.md
@@ -0,0 +1,6 @@
+# Share services
+
+>[!warning] 🚧 WIP
+
+An example of how to share services between flakes.
+<https://github.com/juspay/services-flake/tree/main/example/share-services>
diff --git a/doc/zookeeper.md b/doc/zookeeper.md
@@ -0,0 +1,6 @@
+# Zookeeper
+
+>[!warning] 🚧 WIP
+
+Usage example:
+<https://github.com/juspay/services-flake/blob/main/nix/zookeeper_test.nix>