From 013d9da23859f9f9fe975ca0608f7f53128bdd54 Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Fri, 17 Jan 2020 16:24:18 +0100 Subject: [PATCH] doc: add links to components documentation The page is fairly long, add a table of content at the very top as well as backlinks to the toc. Add links to the Graph to easily jump to the component description. Change-Id: I9ca89813aad2d2b3b229195f3547ee0f0a525cbb --- doc/source/discussion/components.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/source/discussion/components.rst b/doc/source/discussion/components.rst index fd8a3b6b67..1fce46a6b4 100644 --- a/doc/source/discussion/components.rst +++ b/doc/source/discussion/components.rst @@ -5,6 +5,14 @@ Components ========== +.. contents:: + :depth: 1 + :local: + :backlinks: none + +Overview +-------- + Zuul is a distributed system consisting of several components, each of which is described below. @@ -14,12 +22,17 @@ which is described below. graph { node [shape=box] Database [fontcolor=grey] + Executor [href="#executor"] + Finger [href="#finger-gateway"] Gearman [shape=ellipse] Gerrit [fontcolor=grey] + Merger [href="#merger"] Statsd [shape=ellipse fontcolor=grey] + Scheduler [href="#scheduler"] Zookeeper [shape=ellipse] Nodepool GitHub [fontcolor=grey] + Web [href="#web-server"] Merger -- Gearman Executor -- Gearman