From 6f073e25bc2d85282d6c9fbbf858c4e31d73b45c Mon Sep 17 00:00:00 2001
From: yuvipanda <yuvipanda@gmail.com>
Date: Wed, 27 Jun 2018 16:33:14 -0700
Subject: [PATCH] Add docs with mkdocs

There isn't going to be much code generation here, so let's
start with mkdocs and see if it is good enough for us!
---
 docs/index.md        | 23 +++++++++++++++++++++++
 docs/install.md      | 32 ++++++++++++++++++++++++++++++++
 docs/requirements.md | 11 +++++++++++
 mkdocs.yml           |  2 ++
 4 files changed, 68 insertions(+)
 create mode 100644 docs/index.md
 create mode 100644 docs/install.md
 create mode 100644 docs/requirements.md
 create mode 100644 mkdocs.yml

diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..df37a06
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,23 @@
+# The Littlest JupyterHub
+
+A simple [JupyterHub](https://github.com/jupyterhub/jupyterhub) distribution for
+a small (0-50) number of users on a single server.
+
+## Quick Start
+
+On a fresh Ubuntu 18.04 server, you can install The Littlest JupyterHub with:
+
+```bash
+curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash | sudo bash -
+```
+
+This takes 2-5 minutes to run. When completed, you can access your new JupyterHub
+at the public IP of your server!
+
+If this installation method (`curl <arbitrary-url> | sudo bash -`)
+makes you nervous, check out the [other installation methods](install.md) we support!
+
+## Table of Contents
+
+- [Server requirements](requirements.md)
+- [Installation](install.md)
diff --git a/docs/install.md b/docs/install.md
new file mode 100644
index 0000000..a08cbf2
--- /dev/null
+++ b/docs/install.md
@@ -0,0 +1,32 @@
+# Installation
+
+## Quick Installation
+The quick way to install The Littlest JupyterHub (tljh) is:
+
+```bash
+curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash | sudo bash -
+```
+
+This takes 2-5 minutes to run. When completed, you can access your new JupyterHub
+at the public IP of your server!
+
+## Slightly less quick installation
+
+If you can read `bash` and are nervous about the previous installation method,
+you can inspect the installer script before running it.
+
+1. Download the installer script
+
+   ```bash
+   curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash  -o install.bash
+   ```
+
+2. Read the install script source using your favorite text editor
+
+3. Run the installer script
+
+   ```bash
+   sudo install.bash
+   ```
+
+ This should have the exact same effects as the quick installer method.
diff --git a/docs/requirements.md b/docs/requirements.md
new file mode 100644
index 0000000..875dece
--- /dev/null
+++ b/docs/requirements.md
@@ -0,0 +1,11 @@
+# Server Requirements
+
+The Littlest JupyterHub (TLJH) can run on servers that meet at least he following criteria:
+
+1. Ubuntu Linux Operating System (minimum version supported 18.04)
+2. Full root access
+3. Access to the internet
+4. At least 512MB of RAM
+
+While TLJH will run on machines that meet these requirements, you should also
+consider how much resources your individual users need before acquiring a server.
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..c57dd75
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,2 @@
+site_name: The Littlest JupyterHub
+theme: readthedocs