From b691480e5f404a7bff8ffc13aae74c91bef7ec80 Mon Sep 17 00:00:00 2001 From: alwasega Date: Fri, 20 Jan 2023 13:36:16 +0300 Subject: [PATCH] Added docs to the folder --- docs/source/index.md | 12 ++---------- docs/source/installation-guide.md | 13 ------------- docs/source/tutorial/index.md | 13 +++++++++++-- .../installation}/installation-basics.md | 0 .../installation}/quickstart-docker.md | 0 .../{ => tutorial/installation}/quickstart.md | 0 6 files changed, 13 insertions(+), 25 deletions(-) delete mode 100644 docs/source/installation-guide.md rename docs/source/{ => tutorial/installation}/installation-basics.md (100%) rename docs/source/{ => tutorial/installation}/quickstart-docker.md (100%) rename docs/source/{ => tutorial/installation}/quickstart.md (100%) diff --git a/docs/source/index.md b/docs/source/index.md index 90649789..6f468935 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -51,13 +51,13 @@ follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/ Documentation sections (reorganization in-progress) ```{toctree} -:maxdepth: 1 +:maxdepth: 2 -faq/index.md tutorial/index.md howto/index.md explanation/index.md reference/index.md +faq/index.md ``` (index/distributions)= @@ -81,14 +81,6 @@ Today, you can find two main use cases: _It is important to evaluate these distributions before you can continue with the configuration of JupyterHub_. -### Installation Guide - -```{toctree} -:maxdepth: 2 - -installation-guide -``` - ### Getting Started ```{toctree} diff --git a/docs/source/installation-guide.md b/docs/source/installation-guide.md deleted file mode 100644 index 011a796c..00000000 --- a/docs/source/installation-guide.md +++ /dev/null @@ -1,13 +0,0 @@ -# Installation - -These sections cover how to get up-and-running with JupyterHub. They cover -some basics of the tools needed to deploy JupyterHub as well as how to get it -running on your own infrastructure. - -```{toctree} -:maxdepth: 3 - -quickstart -quickstart-docker -installation-basics -``` diff --git a/docs/source/tutorial/index.md b/docs/source/tutorial/index.md index 14d6f1b3..9fa671d0 100644 --- a/docs/source/tutorial/index.md +++ b/docs/source/tutorial/index.md @@ -2,7 +2,16 @@ This section of the documentation provides step-by-step tutorials to help you achieve a specific goal. The tutorials should be a good place to start learning about JupyterHub and how it works. -```{toctree} -:maxdepth: 2 +## Installation +These sections cover how to get up-and-running with JupyterHub. They cover +some basics of the tools needed to deploy JupyterHub as well as how to get it +running on your own infrastructure. + +```{toctree} +:maxdepth: 1 + +installation/quickstart +installation/installation-basics +installation/quickstart-docker ``` diff --git a/docs/source/installation-basics.md b/docs/source/tutorial/installation/installation-basics.md similarity index 100% rename from docs/source/installation-basics.md rename to docs/source/tutorial/installation/installation-basics.md diff --git a/docs/source/quickstart-docker.md b/docs/source/tutorial/installation/quickstart-docker.md similarity index 100% rename from docs/source/quickstart-docker.md rename to docs/source/tutorial/installation/quickstart-docker.md diff --git a/docs/source/quickstart.md b/docs/source/tutorial/installation/quickstart.md similarity index 100% rename from docs/source/quickstart.md rename to docs/source/tutorial/installation/quickstart.md