More doc tweaks (#740)

* Add a repo url This will let people jump directly to editing the docs from the UI, in case further tweaks are required. * Fix omitted renaming of "edge server" to "edge service" * Hide the prev/next buttons by default They aren't very useful and cause the header to collapse vertically in a very awkward way.
mozilla · Aug 13, 2019 · 0952700 · 0952700
1 parent f8bff29
commit 0952700
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/custom_docs_theme/main.html b/custom_docs_theme/main.html
@@ -0,0 +1,4 @@
+{% extends "base.html" %}
+
+{% block next_prev %}
+{% endblock %}
diff --git a/docs/architecture/edge_service_specification.md b/docs/architecture/edge_service_specification.md
@@ -1,4 +1,4 @@
-# Edge Server Specification
+# Edge Service Specification
 
 This document specifies the behavior of the server that accepts submissions
 from HTTP clients e.g. Firefox telemetry.

diff --git a/docs/ingestion-edge/index.md b/docs/ingestion-edge/index.md
@@ -1,4 +1,4 @@
-# Ingestion Edge Server
+# Ingestion Edge Service
 
 A simple service for delivering HTTP messages to Google Cloud PubSub
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,9 @@
 site_name: GCP Ingestion
 site_description: Mozilla Telemetry ingestion on Google Cloud Platform
 site_author: Mozilla Data Platform Team
+
+repo_url: https://github.com/mozilla/gcp-ingestion/
+
 nav:
   - Home: index.md
   - ingestion-edge: ingestion-edge/index.md
@@ -18,3 +21,7 @@ nav:
     - Edge Server Specification: architecture/edge_service_specification.md
     - BigQuery Sink Specification: architecture/bigquery_sink_specification.md
     - Decoder Service Specification: architecture/decoder_service_specification.md
+
+theme:
+    name: mkdocs
+    custom_dir: custom_docs_theme/