From e706d9301c2a2fea079e12a6eaf1ae8cf1c4ae10 Mon Sep 17 00:00:00 2001 From: Shivaraj B H Date: Thu, 21 Mar 2024 00:27:36 +0530 Subject: [PATCH] docs: create placeholders (#156) --- doc/apache-kafka.md | 6 ++++++ doc/elasticsearch.md | 6 ++++++ doc/examples.md | 3 +++ doc/index.md | 2 ++ doc/mysql.md | 6 ++++++ doc/nginx.md | 6 ++++++ doc/redis-cluster.md | 6 ++++++ doc/redis.md | 6 ++++++ doc/services.md | 14 +++++++------- doc/share-services.md | 6 ++++++ doc/zookeeper.md | 6 ++++++ 11 files changed, 60 insertions(+), 7 deletions(-) create mode 100644 doc/apache-kafka.md create mode 100644 doc/elasticsearch.md create mode 100644 doc/examples.md create mode 100644 doc/mysql.md create mode 100644 doc/nginx.md create mode 100644 doc/redis-cluster.md create mode 100644 doc/redis.md create mode 100644 doc/share-services.md create mode 100644 doc/zookeeper.md diff --git a/doc/apache-kafka.md b/doc/apache-kafka.md new file mode 100644 index 00000000..92065670 --- /dev/null +++ b/doc/apache-kafka.md @@ -0,0 +1,6 @@ +# Apache Kafka + +>[!warning] 🚧 WIP + +Usage example: + diff --git a/doc/elasticsearch.md b/doc/elasticsearch.md new file mode 100644 index 00000000..b801d577 --- /dev/null +++ b/doc/elasticsearch.md @@ -0,0 +1,6 @@ +# Elasticsearch + +>[!warning] 🚧 WIP + +Usage example: + diff --git a/doc/examples.md b/doc/examples.md new file mode 100644 index 00000000..50ad65cc --- /dev/null +++ b/doc/examples.md @@ -0,0 +1,3 @@ +# Examples + +- [ ] [[share-services]]# diff --git a/doc/index.md b/doc/index.md index 98057541..b1c63ea4 100644 --- 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 new file mode 100644 index 00000000..00a438d8 --- /dev/null +++ b/doc/mysql.md @@ -0,0 +1,6 @@ +# MySQL + +>[!warning] 🚧 WIP + +Usage example: + diff --git a/doc/nginx.md b/doc/nginx.md new file mode 100644 index 00000000..8a01e9e9 --- /dev/null +++ b/doc/nginx.md @@ -0,0 +1,6 @@ +# Nginx + +>[!warning] 🚧 WIP + +Usage example: + diff --git a/doc/redis-cluster.md b/doc/redis-cluster.md new file mode 100644 index 00000000..b5e02170 --- /dev/null +++ b/doc/redis-cluster.md @@ -0,0 +1,6 @@ +# Redis Cluster + +>[!warning] 🚧 WIP + +Usage example: + diff --git a/doc/redis.md b/doc/redis.md new file mode 100644 index 00000000..86755356 --- /dev/null +++ b/doc/redis.md @@ -0,0 +1,6 @@ +# Redis + +>[!warning] 🚧 WIP + +Usage example: + diff --git a/doc/services.md b/doc/services.md index 382f98d4..99395888 100644 --- 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 new file mode 100644 index 00000000..cf0e880e --- /dev/null +++ b/doc/share-services.md @@ -0,0 +1,6 @@ +# Share services + +>[!warning] 🚧 WIP + +An example of how to share services between flakes. + diff --git a/doc/zookeeper.md b/doc/zookeeper.md new file mode 100644 index 00000000..5354bce7 --- /dev/null +++ b/doc/zookeeper.md @@ -0,0 +1,6 @@ +# Zookeeper + +>[!warning] 🚧 WIP + +Usage example: +