Merge pull request #110 from yuvipanda/install-doc-reorg

Re-organize installation documentation
This commit is contained in:
Yuvi Panda
2018-08-03 14:49:07 -07:00
committed by GitHub
8 changed files with 13 additions and 8 deletions

View File

@@ -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.

View File

@@ -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.

View File

@@ -1,4 +1,4 @@
.. _tutorials/custom:
.. _install/custom:
=============================
Installing on your own server

View File

@@ -1,4 +1,4 @@
.. _tutorial_quickstart_digitalocean:
.. _insatll/digitalocean:
===========================
Installing on Digital Ocean

View File

@@ -1,4 +1,4 @@
.. _tutorial_quickstart_google:
.. _install/google:
==========================
Installing on Google Cloud

View File

@@ -1,4 +1,4 @@
.. _tutorial_quickstart_jetstream:
.. _install/jetstream:
=======================
Installing on Jetstream