docs: create placeholders (#156)

This commit is contained in:
Shivaraj B H 2024-03-21 00:27:36 +05:30 committed by GitHub
parent 819ab20e8e
commit e706d9301c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 60 additions and 7 deletions

6
doc/apache-kafka.md Normal file
View File

@ -0,0 +1,6 @@
# Apache Kafka
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/apache-kafka_test.nix>

6
doc/elasticsearch.md Normal file
View File

@ -0,0 +1,6 @@
# Elasticsearch
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/elasticsearch_test.nix>

3
doc/examples.md Normal file
View File

@ -0,0 +1,3 @@
# Examples
- [ ] [[share-services]]#

View File

@ -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]]#

6
doc/mysql.md Normal file
View File

@ -0,0 +1,6 @@
# MySQL
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/mysql/mysql_test.nix>

6
doc/nginx.md Normal file
View File

@ -0,0 +1,6 @@
# Nginx
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/nginx_test.nix>

6
doc/redis-cluster.md Normal file
View File

@ -0,0 +1,6 @@
# Redis Cluster
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/redis-cluster_test.nix>

6
doc/redis.md Normal file
View File

@ -0,0 +1,6 @@
# Redis
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/redis_test.nix>

View File

@ -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]]#

6
doc/share-services.md Normal file
View File

@ -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>

6
doc/zookeeper.md Normal file
View File

@ -0,0 +1,6 @@
# Zookeeper
>[!warning] 🚧 WIP
Usage example:
<https://github.com/juspay/services-flake/blob/main/nix/zookeeper_test.nix>