From 0873902a18bfcddc0525876f80385399eb992f82 Mon Sep 17 00:00:00 2001 From: alwasega Date: Wed, 18 Jan 2023 00:10:36 +0300 Subject: [PATCH 1/5] Created folders to house the restructured documentation --- docs/source/diataxis-FAQ/index.md | 9 +++++++++ docs/source/diataxis-explanation/index.md | 8 ++++++++ docs/source/diataxis-how-to-guides/index.md | 8 ++++++++ docs/source/diataxis-references/index.md | 8 ++++++++ docs/source/diataxis-tutorials/index.md | 8 ++++++++ 5 files changed, 41 insertions(+) create mode 100644 docs/source/diataxis-FAQ/index.md create mode 100644 docs/source/diataxis-explanation/index.md create mode 100644 docs/source/diataxis-how-to-guides/index.md create mode 100644 docs/source/diataxis-references/index.md create mode 100644 docs/source/diataxis-tutorials/index.md diff --git a/docs/source/diataxis-FAQ/index.md b/docs/source/diataxis-FAQ/index.md new file mode 100644 index 00000000..0592a04d --- /dev/null +++ b/docs/source/diataxis-FAQ/index.md @@ -0,0 +1,9 @@ +# FAQs + +This section will contain documentation that contain frequently-asked questions. + + +```{toctree} +:maxdepth: 2 + +``` \ No newline at end of file diff --git a/docs/source/diataxis-explanation/index.md b/docs/source/diataxis-explanation/index.md new file mode 100644 index 00000000..56bed75e --- /dev/null +++ b/docs/source/diataxis-explanation/index.md @@ -0,0 +1,8 @@ +# Explanation + +This section will contain restructured documentation that fit into the `Explanation` part of the Diataxis model. + +```{toctree} +:maxdepth: 2 + +``` diff --git a/docs/source/diataxis-how-to-guides/index.md b/docs/source/diataxis-how-to-guides/index.md new file mode 100644 index 00000000..3cd19126 --- /dev/null +++ b/docs/source/diataxis-how-to-guides/index.md @@ -0,0 +1,8 @@ +# How-To + +This section will contain restructured documentation that fit into the `How-To guides` part of the Diataxis model. + +```{toctree} +:maxdepth: 2 + +``` \ No newline at end of file diff --git a/docs/source/diataxis-references/index.md b/docs/source/diataxis-references/index.md new file mode 100644 index 00000000..319ae1e2 --- /dev/null +++ b/docs/source/diataxis-references/index.md @@ -0,0 +1,8 @@ +# References + +This section will contain restructured documentation that fit into the `References` part of the Diataxis model. + +```{toctree} +:maxdepth: 2 + +``` \ No newline at end of file diff --git a/docs/source/diataxis-tutorials/index.md b/docs/source/diataxis-tutorials/index.md new file mode 100644 index 00000000..d8289f92 --- /dev/null +++ b/docs/source/diataxis-tutorials/index.md @@ -0,0 +1,8 @@ +# Tutorials + +This section will contain restructured documentation that fit into the `Tutorials` part of the Diataxis model. + +```{toctree} +:maxdepth: 2 + +``` \ No newline at end of file From 1114736ae7ca45b06a9b154d229a571a2f620320 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 17 Jan 2023 21:21:34 +0000 Subject: [PATCH 2/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/diataxis-FAQ/index.md | 5 ++--- docs/source/diataxis-explanation/index.md | 2 +- docs/source/diataxis-how-to-guides/index.md | 4 ++-- docs/source/diataxis-references/index.md | 4 ++-- docs/source/diataxis-tutorials/index.md | 4 ++-- 5 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/source/diataxis-FAQ/index.md b/docs/source/diataxis-FAQ/index.md index 0592a04d..1de9dce3 100644 --- a/docs/source/diataxis-FAQ/index.md +++ b/docs/source/diataxis-FAQ/index.md @@ -1,9 +1,8 @@ # FAQs -This section will contain documentation that contain frequently-asked questions. - +This section will contain documentation that contain frequently-asked questions. ```{toctree} :maxdepth: 2 -``` \ No newline at end of file +``` diff --git a/docs/source/diataxis-explanation/index.md b/docs/source/diataxis-explanation/index.md index 56bed75e..ef63cd36 100644 --- a/docs/source/diataxis-explanation/index.md +++ b/docs/source/diataxis-explanation/index.md @@ -1,6 +1,6 @@ # Explanation -This section will contain restructured documentation that fit into the `Explanation` part of the Diataxis model. +This section will contain restructured documentation that fit into the `Explanation` part of the Diataxis model. ```{toctree} :maxdepth: 2 diff --git a/docs/source/diataxis-how-to-guides/index.md b/docs/source/diataxis-how-to-guides/index.md index 3cd19126..d4a9cb7e 100644 --- a/docs/source/diataxis-how-to-guides/index.md +++ b/docs/source/diataxis-how-to-guides/index.md @@ -1,8 +1,8 @@ # How-To -This section will contain restructured documentation that fit into the `How-To guides` part of the Diataxis model. +This section will contain restructured documentation that fit into the `How-To guides` part of the Diataxis model. ```{toctree} :maxdepth: 2 -``` \ No newline at end of file +``` diff --git a/docs/source/diataxis-references/index.md b/docs/source/diataxis-references/index.md index 319ae1e2..92b61277 100644 --- a/docs/source/diataxis-references/index.md +++ b/docs/source/diataxis-references/index.md @@ -1,8 +1,8 @@ # References -This section will contain restructured documentation that fit into the `References` part of the Diataxis model. +This section will contain restructured documentation that fit into the `References` part of the Diataxis model. ```{toctree} :maxdepth: 2 -``` \ No newline at end of file +``` diff --git a/docs/source/diataxis-tutorials/index.md b/docs/source/diataxis-tutorials/index.md index d8289f92..dc928f6b 100644 --- a/docs/source/diataxis-tutorials/index.md +++ b/docs/source/diataxis-tutorials/index.md @@ -1,8 +1,8 @@ # Tutorials -This section will contain restructured documentation that fit into the `Tutorials` part of the Diataxis model. +This section will contain restructured documentation that fit into the `Tutorials` part of the Diataxis model. ```{toctree} :maxdepth: 2 -``` \ No newline at end of file +``` From 70196a47219f2777d312bb613ab8d5b6bd0bbe19 Mon Sep 17 00:00:00 2001 From: alwasega Date: Wed, 18 Jan 2023 17:16:25 +0300 Subject: [PATCH 3/5] Edited files and folders per comments --- docs/source/diataxis-FAQ/index.md | 8 -------- docs/source/diataxis-explanation/index.md | 8 -------- docs/source/diataxis-how-to-guides/index.md | 8 -------- docs/source/diataxis-references/index.md | 8 -------- docs/source/diataxis-tutorials/index.md | 8 -------- docs/source/explanation/index.md | 8 ++++++++ docs/source/faq/index.md | 9 +++++++++ docs/source/howto/index.md | 8 ++++++++ docs/source/tutorial/index.md | 8 ++++++++ 9 files changed, 33 insertions(+), 40 deletions(-) delete mode 100644 docs/source/diataxis-FAQ/index.md delete mode 100644 docs/source/diataxis-explanation/index.md delete mode 100644 docs/source/diataxis-how-to-guides/index.md delete mode 100644 docs/source/diataxis-references/index.md delete mode 100644 docs/source/diataxis-tutorials/index.md create mode 100644 docs/source/explanation/index.md create mode 100644 docs/source/faq/index.md create mode 100644 docs/source/howto/index.md create mode 100644 docs/source/tutorial/index.md diff --git a/docs/source/diataxis-FAQ/index.md b/docs/source/diataxis-FAQ/index.md deleted file mode 100644 index 1de9dce3..00000000 --- a/docs/source/diataxis-FAQ/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# FAQs - -This section will contain documentation that contain frequently-asked questions. - -```{toctree} -:maxdepth: 2 - -``` diff --git a/docs/source/diataxis-explanation/index.md b/docs/source/diataxis-explanation/index.md deleted file mode 100644 index ef63cd36..00000000 --- a/docs/source/diataxis-explanation/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Explanation - -This section will contain restructured documentation that fit into the `Explanation` part of the Diataxis model. - -```{toctree} -:maxdepth: 2 - -``` diff --git a/docs/source/diataxis-how-to-guides/index.md b/docs/source/diataxis-how-to-guides/index.md deleted file mode 100644 index d4a9cb7e..00000000 --- a/docs/source/diataxis-how-to-guides/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# How-To - -This section will contain restructured documentation that fit into the `How-To guides` part of the Diataxis model. - -```{toctree} -:maxdepth: 2 - -``` diff --git a/docs/source/diataxis-references/index.md b/docs/source/diataxis-references/index.md deleted file mode 100644 index 92b61277..00000000 --- a/docs/source/diataxis-references/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# References - -This section will contain restructured documentation that fit into the `References` part of the Diataxis model. - -```{toctree} -:maxdepth: 2 - -``` diff --git a/docs/source/diataxis-tutorials/index.md b/docs/source/diataxis-tutorials/index.md deleted file mode 100644 index dc928f6b..00000000 --- a/docs/source/diataxis-tutorials/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Tutorials - -This section will contain restructured documentation that fit into the `Tutorials` part of the Diataxis model. - -```{toctree} -:maxdepth: 2 - -``` diff --git a/docs/source/explanation/index.md b/docs/source/explanation/index.md new file mode 100644 index 00000000..abd896c1 --- /dev/null +++ b/docs/source/explanation/index.md @@ -0,0 +1,8 @@ +# Explanation + +The explanation guides are written to provide big-picture explanations of how JupyterHub works. They are meant to build your understanding of particular topics. + +```{toctree} +:maxdepth: 2 + +``` diff --git a/docs/source/faq/index.md b/docs/source/faq/index.md new file mode 100644 index 00000000..dbf1d883 --- /dev/null +++ b/docs/source/faq/index.md @@ -0,0 +1,9 @@ +# FAQs + +Find answers to some of the most frequently-asked questions around JupyterHub and how it works. + + +```{toctree} +:maxdepth: 2 + +``` \ No newline at end of file diff --git a/docs/source/howto/index.md b/docs/source/howto/index.md new file mode 100644 index 00000000..9733d1c7 --- /dev/null +++ b/docs/source/howto/index.md @@ -0,0 +1,8 @@ +# How-to + +The *How-to* guides provide practical step-by-step details to help you achieve a particular goal. They are useful when you are trying to get something done but require you to understand and adapt the steps to your specific usecase. + +```{toctree} +:maxdepth: 2 + +``` \ No newline at end of file diff --git a/docs/source/tutorial/index.md b/docs/source/tutorial/index.md new file mode 100644 index 00000000..b6913ecd --- /dev/null +++ b/docs/source/tutorial/index.md @@ -0,0 +1,8 @@ +# Tutorials + +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 + +``` \ No newline at end of file From 08c14a03d77bceb6e4eb430562f51f3a8d7b0aa7 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 18 Jan 2023 14:15:08 +0000 Subject: [PATCH 4/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/explanation/index.md | 2 +- docs/source/faq/index.md | 5 ++--- docs/source/howto/index.md | 4 ++-- docs/source/tutorial/index.md | 4 ++-- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/source/explanation/index.md b/docs/source/explanation/index.md index abd896c1..07dbcc86 100644 --- a/docs/source/explanation/index.md +++ b/docs/source/explanation/index.md @@ -1,6 +1,6 @@ # Explanation -The explanation guides are written to provide big-picture explanations of how JupyterHub works. They are meant to build your understanding of particular topics. +The explanation guides are written to provide big-picture explanations of how JupyterHub works. They are meant to build your understanding of particular topics. ```{toctree} :maxdepth: 2 diff --git a/docs/source/faq/index.md b/docs/source/faq/index.md index dbf1d883..82929a92 100644 --- a/docs/source/faq/index.md +++ b/docs/source/faq/index.md @@ -1,9 +1,8 @@ # FAQs -Find answers to some of the most frequently-asked questions around JupyterHub and how it works. - +Find answers to some of the most frequently-asked questions around JupyterHub and how it works. ```{toctree} :maxdepth: 2 -``` \ No newline at end of file +``` diff --git a/docs/source/howto/index.md b/docs/source/howto/index.md index 9733d1c7..1a4d68a9 100644 --- a/docs/source/howto/index.md +++ b/docs/source/howto/index.md @@ -1,8 +1,8 @@ # How-to -The *How-to* guides provide practical step-by-step details to help you achieve a particular goal. They are useful when you are trying to get something done but require you to understand and adapt the steps to your specific usecase. +The _How-to_ guides provide practical step-by-step details to help you achieve a particular goal. They are useful when you are trying to get something done but require you to understand and adapt the steps to your specific usecase. ```{toctree} :maxdepth: 2 -``` \ No newline at end of file +``` diff --git a/docs/source/tutorial/index.md b/docs/source/tutorial/index.md index b6913ecd..14d6f1b3 100644 --- a/docs/source/tutorial/index.md +++ b/docs/source/tutorial/index.md @@ -1,8 +1,8 @@ # Tutorials -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. +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 -``` \ No newline at end of file +``` From f434b7ea3327d5c988951ce7900252af5bad2c6b Mon Sep 17 00:00:00 2001 From: alwasega Date: Thu, 19 Jan 2023 14:04:52 +0300 Subject: [PATCH 5/5] Edited source/index.md file --- docs/source/index.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/index.md b/docs/source/index.md index 896a89b0..90649789 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -48,6 +48,18 @@ follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/ ## Contents +Documentation sections (reorganization in-progress) + +```{toctree} +:maxdepth: 1 + +faq/index.md +tutorial/index.md +howto/index.md +explanation/index.md +reference/index.md +``` + (index/distributions)= ### Distributions