Update rendered docs in line with bigquery-etl (#1611)

Uses the `material` theme and some additional plugins.
This commit is contained in:
Jeff Klukas 2021-03-19 09:17:37 -04:00 коммит произвёл GitHub
Родитель 46ad670731
Коммит f96fb3b8c6
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 29 добавлений и 22 удалений

Просмотреть файл

@ -28,7 +28,12 @@ jobs:
- checkout
- run:
name: Install dependencies
command: sudo pip install mkdocs markdown-include
command: |
sudo pip install \
mkdocs \
mkdocs-material \
markdown-include \
mkdocs-awesome-pages-plugin
- add_ssh_keys:
fingerprints:
- "84:b0:66:dd:ec:68:b1:45:9d:5d:66:fd:4a:4f:1b:57"

Просмотреть файл

@ -18,5 +18,5 @@ The components are:
The design behind the system along with various trade offs are documented in
the [architecture section](./architecture/overview.md).
Feel free to ask us in `#fx-metrics` on Slack or `#telemetry` on `chat.mozilla.org`
Feel free to ask us in `#data-help` on Slack or `#telemetry` on `chat.mozilla.org`
if you have specific questions.

Просмотреть файл

@ -4,27 +4,29 @@ site_author: Mozilla Data Platform Team
repo_url: https://github.com/mozilla/gcp-ingestion/
theme:
name: material
features:
- navigation.tabs
palette:
primary: teal
plugins:
- search
- awesome-pages
nav:
- Home: index.md
- ingestion-edge: ingestion-edge/index.md
- ingestion-beam:
- Overview: ingestion-beam/index.md
- Sink Job: ingestion-beam/sink-job.md
- Decoder Job: ingestion-beam/decoder-job.md
- Republisher Job: ingestion-beam/republisher-job.md
- Ingestion testing workflow: ingestion-beam/ingestion_testing_workflow.md
- Architecture:
- Overview: architecture/overview.md
- Differences from AWS: architecture/differences_from_aws.md
- Pain Points: architecture/pain_points.md
- Edge Migration Plan: architecture/edge_migration_plan.md
- Reliability: architecture/reliability.md
- Test requirements: architecture/test_requirements.md
- Landfill Service Specification: architecture/landfill_service_specification.md
- 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/
- ... | architecture/*.md
- ingestion-edge:
- Overview: ingestion-edge/index.md
- ... | ingestion-edge/*
- ingestion-beam:
- Overview: ingestion-beam/index.md
- ... | ingestion-beam/*
- ingestion-sink:
- Overview: ingestion-sink/index.md
- ... | ingestion-sink/*
- ...