diff --git a/docs/source/background/index.md b/docs/source/background/index.md deleted file mode 100644 index ebffe848..00000000 --- a/docs/source/background/index.md +++ /dev/null @@ -1,40 +0,0 @@ -# Background - -_Background_ provides some basic information about JupyterHub and big-picture illustrations of how it works. This section is meant to build your understanding of particular topics and JupyterHub in general. - -## About JupyterHub - -JupyterHub is an open source project and community. It is a part of the -[Jupyter Project](https://jupyter.org). This section covers information -about our community as well as institutions that are presently using JupyterHub. - -```{toctree} -:maxdepth: 1 - -about/gallery-jhub-deployments -../changelog -about/contributor-list -``` - -## Administration - -This section provides information relevant to running your own JupyterHub over time. - -```{toctree} -:maxdepth: 1 - -admin/capacity-planning -admin/database -admin/websecurity -admin/oauth -``` - -## JupyterHub RBAC - -This section covers how Role Based Access Control (RBAC) is implemented in JupyterHub to control access to Jupyterhub's API resources. - -```{toctree} -:maxdepth: 2 - -../rbac/index -``` diff --git a/docs/source/background/about/contributor-list.md b/docs/source/contributor-list.md similarity index 100% rename from docs/source/background/about/contributor-list.md rename to docs/source/contributor-list.md diff --git a/docs/source/background/admin/capacity-planning.md b/docs/source/explanation/admin/capacity-planning.md similarity index 100% rename from docs/source/background/admin/capacity-planning.md rename to docs/source/explanation/admin/capacity-planning.md diff --git a/docs/source/background/admin/database.md b/docs/source/explanation/admin/database.md similarity index 100% rename from docs/source/background/admin/database.md rename to docs/source/explanation/admin/database.md diff --git a/docs/source/background/admin/oauth.md b/docs/source/explanation/admin/oauth.md similarity index 100% rename from docs/source/background/admin/oauth.md rename to docs/source/explanation/admin/oauth.md diff --git a/docs/source/background/admin/websecurity.md b/docs/source/explanation/admin/websecurity.md similarity index 100% rename from docs/source/background/admin/websecurity.md rename to docs/source/explanation/admin/websecurity.md diff --git a/docs/source/explanation/index.md b/docs/source/explanation/index.md new file mode 100644 index 00000000..50e6c9f2 --- /dev/null +++ b/docs/source/explanation/index.md @@ -0,0 +1,26 @@ +# Explanation + +_Explanation_ documentation provide big-picture descriptions of how JupyterHub works. This section is meant to build your understanding of particular topics. + +## Administration + +This section provides information relevant to running your own JupyterHub over time. + +```{toctree} +:maxdepth: 1 + +admin/capacity-planning +admin/database +admin/websecurity +admin/oauth +``` + +## JupyterHub RBAC + +This section covers how Role Based Access Control (RBAC) is implemented in JupyterHub to control access to Jupyterhub's API resources. + +```{toctree} +:maxdepth: 2 + +../rbac/index +``` diff --git a/docs/source/background/about/gallery-jhub-deployments.md b/docs/source/gallery-jhub-deployments.md similarity index 100% rename from docs/source/background/about/gallery-jhub-deployments.md rename to docs/source/gallery-jhub-deployments.md diff --git a/docs/source/index-about.md b/docs/source/index-about.md new file mode 100644 index 00000000..3843cd64 --- /dev/null +++ b/docs/source/index-about.md @@ -0,0 +1,14 @@ +# About + +JupyterHub is an open source project and community. It is a part of the +[Jupyter Project](https://jupyter.org). JupyterHub is an open and inclusive +community, and invites contributions from anyone. This section covers information +about our community, as well as ways that you can connect and get involved. + +```{toctree} +:maxdepth: 1 + +contributor-list +changelog +gallery-jhub-deployments +``` \ No newline at end of file diff --git a/docs/source/index.md b/docs/source/index.md index d0042006..2dd53cef 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -56,7 +56,7 @@ Documentation sections (reorganization in-progress) tutorial/index.md howto/index.md reference/index.md -background/index.md +explanation/index.md faq/index.md ``` @@ -112,6 +112,14 @@ help keep our community welcoming to as many people as possible. contributing/index ``` +### About JupyterHub + +```{toctree} +:maxdepth: 2 + +index-about +``` + ## Indices and tables - {ref}`genindex`