diff --git a/docs/architecture/index.md b/docs/architecture/index.md index 16fceaa99667dc9a5c295ffa354137c0d4809d7f..bf87b1a8f380b5ff1c5441c127fa912146418abe 100644 --- a/docs/architecture/index.md +++ b/docs/architecture/index.md @@ -1,3 +1,3 @@ # Architecture -We follow the principles of infrastructure as code and we decompose configuration in data and templates. \ No newline at end of file +We follow the principles of infrastructure as code, and we decompose configuration in data and templates. diff --git a/docs/index.md b/docs/index.md index b42665fdc34aa6e3d8aa005e5ecacc5e8129d63d..a57f5bc1163f2ab9502d8aa72756102bc8275983 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # GÉANT Automation Platform (GAP) -Welcome to the documentation of the GÉANT Automation Platform, also known simply as GAP. \ +Welcome to the documentation of the GÉANT Automation Platform, also known as GAP. \ The focus of this platform is configuration management and service orchestration for the GÉANT IP/MPLS network. ## Table of Contents diff --git a/docs/overview/index.md b/docs/overview/index.md index fcb2270a05a2732c007bd133bafaa3c6388f497e..5e42c03cdfe42a63ee480d84c106f42760070d98 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -5,7 +5,7 @@ built on top of it ensuring that it meets requirements in terms of functionaliti In the context of the IP/MPLS layer and particularly the backbone routers, different teams manage configuration in different ways: to deploy new nodes and to operate the network, they use various tools en methods. Compliance and -quality are checked afterwards: this approach requires much manual work and it is inherently error prone. +quality are checked afterwards: this approach requires much manual work, and it is inherently error-prone. This project aims to standardize the configuration and the configuration deployment process by using Open Source tools and DevOps strategies: one single framework to deploy and to operate. Considering the network configuration as code and @@ -13,8 +13,8 @@ managing it under a version control system (GitLab) will enable better visibilit standardize the way of working. The goal is to reduce configuration drifts and exceptions, Mean Time To Repair (MTTR) in case of fault, and possibly the -number and the severity of incidents. To check configuration compliance before it gets deployed, several policies are in -place: multiple non-production environments are used to automatically execute regression and acceptance tests, in order +number and the severity of incidents. To verify configuration compliance before it gets deployed, several policies are in +place. Multiple non-production environments are used to automatically run regression and acceptance tests, in order to ensure the highest quality and to detect problems early. Automated configuration management must be considered as the foundation of further work in network automation, towards diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini index 40ac0a2b2eb018c37ec6cb4294a9467f0a2eee18..f2a63e2d149817d4e700d6d4a165cda3f06a9cd9 100644 --- a/docs/vale/.vale.ini +++ b/docs/vale/.vale.ini @@ -4,7 +4,7 @@ MinAlertLevel = suggestion Vocab = geant-jargon, Sphinx -Packages = RedHat, proselint, Readability +Packages = RedHat, proselint [*] -BasedOnStyles = Vale, RedHat, proselint, Readability +BasedOnStyles = Vale, RedHat, proselint