diff --git a/docs/huntsman/src/index.md b/docs/huntsman/src/index.md index 98aa34b60..55e7b9103 100644 --- a/docs/huntsman/src/index.md +++ b/docs/huntsman/src/index.md @@ -8,6 +8,13 @@ Spider's docs are separated into the following categories: ::::{grid} 1 1 2 2 :gutter: 2 +:::{grid-item-card} +:link: user-docs/index +🧑 User docs +^^^ +Docs for using Spider. +::: + :::{grid-item-card} :link: dev-docs/index 🛠 Developer docs @@ -19,5 +26,6 @@ Docs for those interested in developing Spider. :::{toctree} :hidden: +user-docs/index.md dev-docs/index.md ::: diff --git a/docs/huntsman/src/user-docs/guides-configuration/index.md b/docs/huntsman/src/user-docs/guides-configuration/index.md new file mode 100644 index 000000000..e79a67026 --- /dev/null +++ b/docs/huntsman/src/user-docs/guides-configuration/index.md @@ -0,0 +1,40 @@ +# Configuration + +:::{warning} +🚧 This section is still under construction. +::: + +The guides below describe how to configure each of Spider's components. + +::::{grid} 1 1 2 2 +:gutter: 2 + +:::{grid-item-card} +:link: storage +Storage configuration +^^^ +How to configure Spider's storage backend. +::: + +:::{grid-item-card} +:link: scheduler +Scheduler configuration +^^^ +How to configure Spider's scheduler. +::: + +:::{grid-item-card} +:link: worker +Worker configuration +^^^ +How to configure Spider's workers. +::: +:::: + +:::{toctree} +:hidden: + +storage.md +scheduler.md +worker.md +::: diff --git a/docs/huntsman/src/user-docs/guides-configuration/scheduler.md b/docs/huntsman/src/user-docs/guides-configuration/scheduler.md new file mode 100644 index 000000000..447e25f77 --- /dev/null +++ b/docs/huntsman/src/user-docs/guides-configuration/scheduler.md @@ -0,0 +1,5 @@ +# Scheduler configuration + +:::{warning} +🚧 This section is still under construction. +::: diff --git a/docs/huntsman/src/user-docs/guides-configuration/storage.md b/docs/huntsman/src/user-docs/guides-configuration/storage.md new file mode 100644 index 000000000..81ae6cfba --- /dev/null +++ b/docs/huntsman/src/user-docs/guides-configuration/storage.md @@ -0,0 +1,5 @@ +# Storage configuration + +:::{warning} +🚧 This section is still under construction. +::: diff --git a/docs/huntsman/src/user-docs/guides-configuration/worker.md b/docs/huntsman/src/user-docs/guides-configuration/worker.md new file mode 100644 index 000000000..727e36ca1 --- /dev/null +++ b/docs/huntsman/src/user-docs/guides-configuration/worker.md @@ -0,0 +1,5 @@ +# Worker configuration + +:::{warning} +🚧 This section is still under construction. +::: diff --git a/docs/huntsman/src/user-docs/guides-deployment/docker-compose.md b/docs/huntsman/src/user-docs/guides-deployment/docker-compose.md new file mode 100644 index 000000000..74a35092e --- /dev/null +++ b/docs/huntsman/src/user-docs/guides-deployment/docker-compose.md @@ -0,0 +1,5 @@ +# Docker Compose deployment + +:::{warning} +🚧 This section is still under construction. +::: diff --git a/docs/huntsman/src/user-docs/guides-deployment/index.md b/docs/huntsman/src/user-docs/guides-deployment/index.md new file mode 100644 index 000000000..49dc1fb9d --- /dev/null +++ b/docs/huntsman/src/user-docs/guides-deployment/index.md @@ -0,0 +1,32 @@ +# Deployment + +:::{warning} +🚧 This section is still under construction. +::: + +The guides below describe how to deploy a Spider cluster. + +::::{grid} 1 1 2 2 +:gutter: 2 + +:::{grid-item-card} +:link: kubernetes +Kubernetes deployment +^^^ +How to deploy Spider on Kubernetes. +::: + +:::{grid-item-card} +:link: docker-compose +Docker Compose deployment +^^^ +How to deploy Spider using Docker Compose. +::: +:::: + +:::{toctree} +:hidden: + +kubernetes.md +docker-compose.md +::: diff --git a/docs/huntsman/src/user-docs/guides-deployment/kubernetes.md b/docs/huntsman/src/user-docs/guides-deployment/kubernetes.md new file mode 100644 index 000000000..dc4f3690d --- /dev/null +++ b/docs/huntsman/src/user-docs/guides-deployment/kubernetes.md @@ -0,0 +1,5 @@ +# Kubernetes deployment + +:::{warning} +🚧 This section is still under construction. +::: diff --git a/docs/huntsman/src/user-docs/index.md b/docs/huntsman/src/user-docs/index.md new file mode 100644 index 000000000..e5b630f31 --- /dev/null +++ b/docs/huntsman/src/user-docs/index.md @@ -0,0 +1,31 @@ +# User docs + +This section contains docs for using and operating Spider. Choose one of the sections below or use +the left sidebar (if it's hidden, click the icon) to navigate to specific +docs. + +::::{grid} 1 1 2 2 +:gutter: 2 + +:::{grid-item-card} +:link: guides-deployment/index +Deployment +^^^ +How to deploy a Spider cluster. +::: + +:::{grid-item-card} +:link: guides-configuration/index +Configuration +^^^ +How to configure Spider's components. +::: +:::: + +:::{toctree} +:hidden: +:caption: Guides + +guides-deployment/index.md +guides-configuration/index.md +:::