From 095270056bf49b107c01bc3df6257d3752ad41ba Mon Sep 17 00:00:00 2001 From: William Lachance Date: Tue, 13 Aug 2019 13:53:37 -0400 Subject: [PATCH] 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. --- custom_docs_theme/main.html | 4 ++++ docs/architecture/edge_service_specification.md | 2 +- docs/ingestion-edge/index.md | 2 +- mkdocs.yml | 7 +++++++ 4 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 custom_docs_theme/main.html diff --git a/custom_docs_theme/main.html b/custom_docs_theme/main.html new file mode 100644 index 000000000..0dc444cdb --- /dev/null +++ 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 index 8d25f0ff1..731fd7234 100644 --- 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 index 52715a970..ad0f7cb44 100644 --- 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 index fb666620e..f25a3d441 100644 --- 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/