Merge pull request #20 from EOSC-synergy/devel/V1.0

Devel/v1.0

Author: mariojmdavid

.gitignore

@@ -38,3 +38,5 @@ Thumbs.db
 
 ## Text Editors
 .vscode
+*.swp
+*.swo

content/01.abstract.md

@@ -3,5 +3,5 @@
 The purpose of this document is to define a set of quality standards,
 procedures and best practices to conform a Service Quality Assurance
 plan to serve as a reference within the European research ecosystem 
-elated projects for the adequate development, deployment, operation
+related projects for the adequate development, deployment, operation
 and integration of services into production research infrastructures.

content/02.0.copyright-ack.md

@@ -1,6 +1,6 @@
 ## Copyright Notice
 
-Copyright © Members of the EOSC-Synergy collaborations, 2019-2020.
+Copyright © Members of the EOSC-Synergy collaboration, 2019-2020.
 
 ## Acknowledgements
 

content/02.document-log.md

@@ -1,6 +1,8 @@
 ## Document Log
 
-| Issue | Date       | Comment              |
-|-------|------------|----------------------|
-| v0.1  | 27/04/2020 | First draft version  |
-| v0.2  | 28/02/2020 | Second draft version |
+| Issue        | Date       | Comment              |
+|--------------|------------|----------------------|
+| v0.1         | 27/04/2020 | First draft version  |
+| v0.2         | 28/02/2020 | Second draft version |
+| v1.0-beta03  | 09/06/2020 | beta03 draft version |
+| v1.0         | 12/06/2020 | v1.0 release         |

content/03.intro.md

@@ -10,24 +10,24 @@ services, such as their stability or functional suitability.
 
 The meaning of **Service** can be regarded from different perspectives.
 From an IT Service Management (ITSM) standpoint, such as the EOSC Service Management
-System (SMS) process model, a service is devised as a means to "provide value
+System (SMS) process model, a **Service** is devised as a means to "provide value
 to the customer". The same goal is shared by the DevOps paradigm, but in this
-case there is a more pragmatic vision the customer satisfaction is achieved
-through the continuous delivery of quality-assured services, with a shorter
+case there is a more pragmatic vision that the customer satisfaction is achieved
+through the continuous delivery of quality-assured **Services**, with a shorter
 life cycle, as the final outcome of a comprehensive software development process.
 
-The ITSM model has a broader focus. A service is an "intangible asset" that
+The ITSM model has a broader focus. A **Service** is an "intangible asset" that
 also includes additional activities such as customer engagement and support.
 Consequently, it is a much heavier process that might not be appropriate to
-be applicable for all types of services. The DevOps model, on the other hand,
+be applicable for all types of **Services**. The DevOps model, on the other hand,
 narrows down the scope to meet the user expectations by acting exclusively on
-the quality features of the service, which is seen as an aggregate of software
+the quality features of the **Service**, which is seen as an aggregate of software
 components in operation.
 
 ## Purpose
 
-This document provides an initial approach to Service Quality Assurance,
-meant to be applied in the integration process of the services existing
+This document provides an initial approach to **Service Quality Assurance**,
+meant to be applied in the integration process of the **Services** existing
 under the EOSC-Synergy project, which eventually will be accessible as part
 of the EOSC offerings.
 
@@ -37,29 +37,30 @@ conventions. To this end, the criteria herein compiled builds on the DevOps
 culture already established in the preceding Software Quality Assurance baseline
 document [@url:https://digital.csic.es/handle/10261/160086] to outline the set
 of good practices that seek the usability and
-reliability of services, and meet the user expectations in terms of functional
+reliability of **Services**, and meet the user expectations in terms of functional
 requirements.
 
 ## Contextualization of a Service
 
-As a result, a **Service**, as conceived in this document, represent the following:
+As a result, a **Service**, as conceived in this document, represents the following:
 
-* Web service [WS] [@url:https://techterms.com/definition/web_service]:
-    * A web service is an application or data source that is accessible via
+* **Web Service** [@url:https://techterms.com/definition/web_service]:
+    * A **Web Service** is an application or data source that is accessible via
     a standard web protocol (HTTP or HTTPS).
-    * Web services are designed to communicate with other programs,
+    * **Web Services** are designed to communicate with other programs,
     rather than directly with users.
-    * Most web services provide an API, or a set of functions and commands,
+    * Most **Web Services** provide an API, or a set of functions and commands,
     that can be used to access the data.
 
-* Web application [WApp] [@url:https://techterms.com/definition/web_application]:
-    * A web application or "web app" is a software program that runs on a web server.
-    * Web apps must be accessed through a web browser.
+* **Web Application** [@url:https://techterms.com/definition/web_application]:
+    * A **Web Application** or "Web App" is a software program that is delivered over
+    the Internet and is accessed through a web browser.
 
-* Platform or Service Composition [Plat]
+* **Platform** or **Service Composition**
 [@url:https://csrc.nist.gov/glossary/term/Service_Composition]:
-    * Aggregation of multiple small services into larger services.
-    * An integrated set of Web services, Web applications and software components.
+    * Aggregation of multiple small services into larger services,
+    according to a service-oriented (SOA) and/or microservices architecture.
+    * An integrated set of **Web Services**, **Web Applications** and software components.
 
 Examples are: Web portals, Scientific portals and gateways, data repositories.
 

content/04.goals.md

@@ -17,7 +17,7 @@ the services, with a focus on the underlying software, thus ensuring a proper
 realization of the verification and validation processes.
 
 * Ensure the functional suitability of the service by promoting testing
-techniques that check the compliance of the user requirements.
+techniques that check the compliance with the user requirements.
 
 * Improve the usability by identifying the set of criteria that fosters the
 service adoption.