From dc3a4c105a98b8fa200ae31fe3fe915e79ba8eb8 Mon Sep 17 00:00:00 2001 From: Alessandro Cerioni <acerioni@grandlyon.com> Date: Mon, 2 Dec 2019 17:46:36 +0100 Subject: [PATCH] Fixed headers --- docs/overview/index.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/overview/index.md b/docs/overview/index.md index 2dfabe2..4e65c33 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -34,7 +34,7 @@ package "data.grandlyon.com" { **This development project concerns the Web Portal component only.** -# Main features +## Main features The data.grandlyon.com's Web Portal includes the following main features: @@ -66,14 +66,14 @@ Support | F21 - Allowing users to contact the user support | end-users The data.grandlyon.com's Web Portal also features an independent GUI allowing the back-office users to administer the editorial content. -# Architecture +## Architecture ...an overview... -# Components +## Components -## Core components +### Core components The following table lists, in alphabetical order, the components of data.grandlyon.com's Core macro-component that are used by the Web Portal: @@ -89,7 +89,7 @@ The latter components being provided by the Core macro-component of the data.gra <!-- Notes: * The component C1 is deemed as "legacy" because... --> -## Off-the-shelf applications +### Off-the-shelf applications ID | Name | Website | Usage --- | --- | --- | --- @@ -102,13 +102,13 @@ A6 | Postfix | [Link](http://www.postfix.org/) | SMTP Server -## Middlewares +### Middlewares ID | Name | Repo | Doc | Usage | Deps --- | --- | --- | --- | --- | --- M1 | Legacy AUTH | ... | ... | Facilitating the interaction between the Web Portal Authentication Service (S1) and the AUTHN/AUTHZ Service (C1) hosted by data.grandlyon.com's Core macro-component | C1 -## Proxies +### Proxies ID | Name | Repo | Doc | Usage | Deps --- | --- | --- | --- | --- | --- @@ -116,7 +116,7 @@ P1 | Map Proxy | ... | ... | Proxying requests that the Web Portal performs agai -## Indexers +### Indexers The following custom indexers are used to index documents in Elasticsearch (A1) in order to make them full-text searchable. @@ -126,7 +126,7 @@ I1 | Editorial Content | ... | ... | Indexing the posts and pages edited in Ghos I2 | Metadata and Data | ... | ... | Indexing the metadata and data hosted, respectively, by data.grandlyon.com's catalog (C3) and database (C4) | C3, C4 -## Services +### Services In alphabetical order: @@ -142,7 +142,7 @@ S7 | Organizations | ... | ... | A catalog of the partners of the data.grandlyon S8 | Resources Helper | ... | ... | Assisting users in the composition of custom queries against the Core APIs | S9 | Reuses | ... | ... | A catalog of the known reuses of the data shared through data.grandlyon.com | S6 -## Specific applications +### Specific applications ID | Name | Repo | Doc | Usage | Deps --- | --- | --- | --- | --- | --- D1 | Web App | ... | ... | Web Application representing the actual Web Portal as seen by its end-users | S[1,9] -- GitLab