From 3c861d3427d3884896b88ff37e40997128ad4127 Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Thu, 2 Aug 2018 12:35:36 -0700 Subject: [PATCH 1/2] Move installer documentation to its own directory Specific & different enough from tutorials --- docs/index.rst | 8 ++++---- docs/{tutorials => install}/add_packages.txt | 0 docs/{tutorials => install}/add_users.txt | 0 docs/{tutorials => install}/custom.rst | 2 +- docs/{tutorials => install}/digitalocean.rst | 2 +- docs/{tutorials => install}/google.rst | 2 +- docs/{tutorials => install}/jetstream.rst | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) rename docs/{tutorials => install}/add_packages.txt (100%) rename docs/{tutorials => install}/add_users.txt (100%) rename docs/{tutorials => install}/custom.rst (99%) rename docs/{tutorials => install}/digitalocean.rst (99%) rename docs/{tutorials => install}/google.rst (99%) rename docs/{tutorials => install}/jetstream.rst (99%) diff --git a/docs/index.rst b/docs/index.rst index 0dbe514..7fe6409 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,11 +26,11 @@ Ubuntu 18.04. We have a bunch of tutorials to get you started. .. toctree:: :titlesonly: - tutorials/digitalocean - tutorials/jetstream - tutorials/google + install/digitalocean + install/jetstream + install/google -- :ref:`tutorials/custom`. +- :ref:`install/custom`. You should use this if your cloud provider does not already have a direct tutorial, or if you have experience setting up servers. diff --git a/docs/tutorials/add_packages.txt b/docs/install/add_packages.txt similarity index 100% rename from docs/tutorials/add_packages.txt rename to docs/install/add_packages.txt diff --git a/docs/tutorials/add_users.txt b/docs/install/add_users.txt similarity index 100% rename from docs/tutorials/add_users.txt rename to docs/install/add_users.txt diff --git a/docs/tutorials/custom.rst b/docs/install/custom.rst similarity index 99% rename from docs/tutorials/custom.rst rename to docs/install/custom.rst index e9405cb..03031de 100644 --- a/docs/tutorials/custom.rst +++ b/docs/install/custom.rst @@ -1,4 +1,4 @@ -.. _tutorials/custom: +.. _install/custom: ============================= Installing on your own server diff --git a/docs/tutorials/digitalocean.rst b/docs/install/digitalocean.rst similarity index 99% rename from docs/tutorials/digitalocean.rst rename to docs/install/digitalocean.rst index d625727..beabb94 100644 --- a/docs/tutorials/digitalocean.rst +++ b/docs/install/digitalocean.rst @@ -1,4 +1,4 @@ -.. _tutorial_quickstart_digitalocean: +.. _insatll/digitalocean: =========================== Installing on Digital Ocean diff --git a/docs/tutorials/google.rst b/docs/install/google.rst similarity index 99% rename from docs/tutorials/google.rst rename to docs/install/google.rst index e5c3dce..48c02f7 100644 --- a/docs/tutorials/google.rst +++ b/docs/install/google.rst @@ -1,4 +1,4 @@ -.. _tutorial_quickstart_google: +.. _install/google: ========================== Installing on Google Cloud diff --git a/docs/tutorials/jetstream.rst b/docs/install/jetstream.rst similarity index 99% rename from docs/tutorials/jetstream.rst rename to docs/install/jetstream.rst index f695c4e..ebc2ef7 100644 --- a/docs/tutorials/jetstream.rst +++ b/docs/install/jetstream.rst @@ -1,4 +1,4 @@ -.. _tutorial_quickstart_jetstream: +.. _install/jetstream: ======================= Installing on Jetstream From 3984db0e65306be23979efc41036470e4c90e8ab Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Fri, 3 Aug 2018 14:42:44 -0700 Subject: [PATCH 2/2] Add note about installation tutorials --- docs/contributing/docs.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/contributing/docs.rst b/docs/contributing/docs.rst index eb6dfbc..ee2bbbf 100644 --- a/docs/contributing/docs.rst +++ b/docs/contributing/docs.rst @@ -85,6 +85,11 @@ The documentation is organized into several categories: not what you explain. It can be helpful to refer back to what you've done and explain afterwards. + **Installation Tutorials** are a special subcategory of tutorials that + teach the user how to install TLJH in various cloud providers / bare metal + systems. These should cross-link a lot to other parts of the documentation, + avoid forcing the user to learn to SSH if possible & have lots of screenshots. + * **Topic guides** aim to explain a concept or subject at a fairly high level.