Improved documentation site with new UI and more explanation

adamkewley · Sep 1, 2018 · ff4d79c · ff4d79c
2 parents b45f0af + 9f3dbbd
commit ff4d79c
Show file tree

Hide file tree

Showing 13 changed files with 890 additions and 598 deletions.
diff --git a/jobson-docs/src/main/jekyll/Ubuntu-L.ttf b/jobson-docs/src/main/jekyll/Ubuntu-L.ttf
diff --git a/jobson-docs/src/main/jekyll/Ubuntu-M.ttf b/jobson-docs/src/main/jekyll/Ubuntu-M.ttf
diff --git a/jobson-docs/src/main/jekyll/_includes/header.html b/jobson-docs/src/main/jekyll/_includes/header.html
@@ -0,0 +1,10 @@
+<header id="header-site">
+  <div class="wrap">
+    <h1>Jobson</h1>
+    <nav>
+      <a href="index.html">docs</a>
+      <a href="https://github.com/adamkewley/jobson">source</a>
+      <a href="https://github.com/adamkewley/jobson/releases">download</a>
+    </nav>
+  </div>
+</header>
diff --git a/jobson-docs/src/main/jekyll/_includes/navbar.html b/jobson-docs/src/main/jekyll/_includes/navbar.html
@@ -0,0 +1,10 @@
+<ul>
+  <li><a href="index.html">Overview</a></li>
+  <li><a href="quickstart.html">Quickstart</a></li>
+  <li><a href="https://github.com/adamkewley/jobson">Install</a></li>
+  <li><a href="commandline.html">Command-Line Interface</a></li>
+  <li><a href="workspaces.html">Workspaces</a></li>
+  <li><a href="specs.html">Job Specs</a></li>
+  <li><a href="template-expressions.html">Template Expressions</a></li>
+  <li><a href="server-configuration.html">Server Configuration</a></li>
+</ul>
diff --git a/jobson-docs/src/main/jekyll/_layouts/default.html b/jobson-docs/src/main/jekyll/_layouts/default.html
@@ -10,10 +10,28 @@
                                    maximum-scale=1, user-scalable=no">
 
     <link rel="stylesheet" type="text/css" href="main.css">
+
   </head>
 
   <body>
-    <h1>Jobson</h1>
-    {{ content }}    
+    {% include header.html %}
+
+    <header id="section-title">
+      <div class="wrap">
+	<h1>{{page.title}}</h1>
+      </div>
+    </header>
+
+    <section id="content">
+      <div class="wrap">
+	<main id="content-primary">
+	  {{ content }}
+	</main>
+
+	<nav id="content-nav">
+	  {% include navbar.html %}
+	</nav>
+      </div>
+    </section>
   </body>
 </html>
diff --git a/jobson-docs/src/main/jekyll/commandline.md b/jobson-docs/src/main/jekyll/commandline.md
@@ -0,0 +1,48 @@
+---
+layout: default
+title: Command-Line Interface
+---
+
+The command-line interface (CLI) for Jobson, `jobson`, contains
+commands aimed at day-to-day development and administration of
+Jobson. The CLI is available once jobson has been
+[installed](https://github.com/adamkewley/jobson).
+
+
+## Viewing Help with `--help`
+
+Pass the `--help` argument to `jobson` to view the help documentation
+for a particular command.
+
+```bash
+$ jobson --help
+usage: java -jar jobson-0.0.11.jar
+       [-h] [-v] {server,check,new,generate,users,validate,run} ...
+
+positional arguments:
+  {server,check,new,generate,users,validate,run}
+                         available commands
+
+optional arguments:
+  -h, --help             show this help message and exit
+  -v, --version          show the application version and exit
+```
+
+
+The `--help` argument also works with the other subcommands:
+
+```bash
+$ jobson new --help
+usage: java -jar jobson-0.0.11.jar
+       new [--demo] [-h]
+
+generate a new jobson deployment in the current working directory
+
+optional arguments:
+  --demo                 Generate application with a demo spec (default: false)
+  -h, --help             show this help message and exit
+```
+
+
+HELP TODO: The in-CLI documentation explains the commands, but having
+the documentation here also would be useful to devs.