diff --git a/docs/conf.py b/docs/conf.py index 6daff6ebe5538eec95930f6d31addd9c73cdb52f..65b2cfaeed2390d03fed49af9f468ff40028dd49 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,3 +19,8 @@ suppress_warnings = ['myst.strikethrough'] # -- Options for HTML output ------------------------------------------------- html_theme = 'sphinx_rtd_theme' html_static_path = ['static'] +html_theme_options = { + 'style_nav_header_background': 'rgb(0 63 95)', +} +html_css_files = ['custom.css'] +html_logo = 'static/geant_logo_white.svg' diff --git a/docs/glossary.md b/docs/glossary.md index 519be3da5793e17d9ec1cf129ca69267ed6b3252..64541eb760c919943e3eb473c0757abcaaabef9d 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -44,4 +44,4 @@ SDP : Service Delivery Point WFO -: Workflow Orchestrator +: <a href="https://workfloworchestrator.org/" target="_blank">Workflow Orchestrator</a> diff --git a/docs/index.md b/docs/index.md index a711d0eb473a072f8213c80be996bc5612276477..528a1629dd6b2a11890370c110cd6c5340f6136d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,11 +3,24 @@ Welcome to the documentation of the GÉANT Automation Platform, or {term}`GAP` for short. \ The focus of this platform is configuration management and service orchestration for the GÉANT IP/{term}`MPLS` network. -## Table of contents +This documentation contains the following sections: + ```{toctree} +:caption: Background :maxdepth: 2 overview/index.md architecture/index.md -processes/index.md +``` + +```{toctree} +:caption: Processes +:maxdepth: 2 +processes/node_provisioning.md +processes/deploy_router.md +``` + +```{toctree} +:caption: — +:maxdepth: 2 glossary.md ``` diff --git a/docs/processes/deploy_router.md b/docs/processes/deploy_router.md index 6b5518dd1686c754de4c034c3f445a20cb811659..3dbfd118788cb013a26d64113827f66e4cf17a7a 100644 --- a/docs/processes/deploy_router.md +++ b/docs/processes/deploy_router.md @@ -1,4 +1,4 @@ -## Router deployment +# Router deployment From a bird's-eye view, the process of deploying a new router in the network is as follows: diff --git a/docs/processes/index.md b/docs/processes/index.md deleted file mode 100644 index edc1fd2d7f627dceb7fde061abe327c30100a15b..0000000000000000000000000000000000000000 --- a/docs/processes/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Processes - -This section describes the mechanics for deploying different types of devices in the GÉANT network. - -```{include} node_provisioning.md -``` - -```{include} deploy_router.md -``` diff --git a/docs/processes/node_provisioning.md b/docs/processes/node_provisioning.md index 3afdb6784c808f60215f82c3264414b819b39f10..5c888a61ed5fd2fa3a3b68438c218bcdddbd6414 100644 --- a/docs/processes/node_provisioning.md +++ b/docs/processes/node_provisioning.md @@ -1,4 +1,4 @@ -## Node provisioning +# Node provisioning A node can either be a router, a switch, or a terminal server. In general -- as laid out more extensively [here](https://wiki.geant.org/display/NETENG/001+-+Topology+and+physical+layout) (behind login) -- a {term}`PoP` diff --git a/docs/static/custom.css b/docs/static/custom.css new file mode 100644 index 0000000000000000000000000000000000000000..7297b93dc4b35f38c353d1d31917bdac92094156 --- /dev/null +++ b/docs/static/custom.css @@ -0,0 +1,3 @@ +.wy-menu > p > span { + color: rgb(237 21 86); +} diff --git a/docs/static/geant_logo_white.svg b/docs/static/geant_logo_white.svg new file mode 100644 index 0000000000000000000000000000000000000000..31bfead62b052812096b5a9c79cf782ce330a87c --- /dev/null +++ b/docs/static/geant_logo_white.svg @@ -0,0 +1,16 @@ +<svg width="79" height="35" viewBox="0 0 79 35" fill="none" xmlns="http://www.w3.org/2000/svg"> +<g clip-path="url(#clip0_101_15)"> +<path d="M15.9 17.8C16.5 17.3 17 17.1 17.4 17.1C18.4 17.1 18.7 17.8 18.7 18.2C18.5 18.3 14.2 19.7 14 19.8C13.9 19.7 13.9 19.6 13.8 19.6C14 19.4 15.9 17.8 15.9 17.8Z" fill="white" fill-opacity="0.85"/> +<path d="M0 27C0 31.8 2.1 34.3 6.3 34.3C9.1 34.3 10.8 33.1 10.8 33L10.9 32.9V26.2H5.2V28.1C5.2 28.1 8.1 28.1 8.6 28.1C8.6 28.6 8.6 31.6 8.6 31.9C8.3 32.1 7.4 32.4 6.2 32.4C3.7 32.4 2.5 30.6 2.5 27C2.5 24.9 3.1 22.4 5.9 22.4C7.8 22.4 8.5 23.5 8.5 24.5V24.8H11.1V24.5C11.1 22.1 9 20.5 5.9 20.5C2.2 20.5 0 22.9 0 27Z" fill="white" fill-opacity="0.85"/> +<path d="M20.2 20.7H12.6V34.1H20.7V32.2C20.7 32.2 15.5 32.2 14.9 32.2C14.9 31.7 14.9 28.5 14.9 28C15.5 28 20.2 28 20.2 28V26.1C20.2 26.1 15.5 26.1 14.9 26.1C14.9 25.6 14.9 23 14.9 22.5C15.5 22.5 20.5 22.5 20.5 22.5V20.6H20.2V20.7Z" fill="white" fill-opacity="0.85"/> +<path d="M54.5 20.7H42.9C42.9 20.7 42.9 28.7 42.9 30.6C42 29 37.2 20.7 37.2 20.7H34.5V34.1H36.8C36.8 34.1 36.8 26.1 36.8 24.2C37.7 25.8 42.5 34.1 42.5 34.1H45.2C45.2 34.1 45.2 23.2 45.2 22.6C45.7 22.6 48.4 22.6 48.9 22.6C48.9 23.2 48.9 34.1 48.9 34.1H51.3C51.3 34.1 51.3 23.2 51.3 22.6C51.8 22.6 54.9 22.6 54.9 22.6V20.7H54.5V20.7Z" fill="white" fill-opacity="0.85"/> +<path d="M28.9 20.7H28.7H26.4L21.4 34.1H23.8C23.8 34.1 25.1 30.6 25.3 30.2C25.7 30.2 29.8 30.2 30.2 30.2C30.3 30.6 31.7 34.1 31.7 34.1H34L28.9 20.7ZM25.9 28.3C26.1 27.6 27.3 24.4 27.7 23.3C28.1 24.4 29.2 27.6 29.5 28.3C28.7 28.3 26.6 28.3 25.9 28.3Z" fill="white" fill-opacity="0.85"/> +<path d="M77 8C68.2 -2.9 32.6 12.5 23 16.5C22.3 16.8 21.4 16.7 20.9 15.7C21.3 16.7 22.1 17.1 23.1 16.7C35.8 11.6 66.5 0.600002 74.2 10.7C77.7 15.3 76.7 20.9 72.9 28.8C72.7 29.1 72.6 29.4 72.6 29.4C72.6 29.4 72.6 29.4 72.6 29.5C72.6 29.5 72.6 29.5 72.6 29.6C72.3 30.1 71.9 30.3 71.6 30.4C72 30.4 72.5 30.2 72.9 29.6C73 29.5 73.1 29.3 73.3 29C78.7 19.5 80.7 12.5 77 8Z" fill="white" fill-opacity="0.85"/> +<path d="M70.3 29.9C70.2 29.8 68.6 28.4 67 26.9C58.7 19 33.4 -5.3 22.4 1.1C19.3 2.9 18.8 8.2 20.7 15.2C20.7 15.3 20.8 15.4 20.8 15.5C21 16.2 21.5 16.7 22.2 16.7C21.7 16.6 21.3 16.2 21.1 15.7C21.1 15.6 21 15.5 21 15.5C21 15.4 20.9 15.3 20.9 15.1C20.9 15 20.9 14.9 20.8 14.9C19.8 9 21 5.1 23.4 3.5C32.3 -2.5 53.5 15.8 64.2 25C66.6 27.1 69.4 29.5 70.2 30.1C71.4 31 72.4 30 72.7 29.5C72.3 30.1 71.3 30.7 70.3 29.9Z" fill="white" fill-opacity="0.85"/> +</g> +<defs> +<clipPath id="clip0_101_15"> +<rect width="78.9" height="34.3" fill="white"/> +</clipPath> +</defs> +</svg>