covid19/cwa-documentation
covid19/cwa-documentation
1
0
Fork 0
mirror of https://github.com/corona-warn-app/cwa-documentation synced 2025-07-04 12:28:35 +02:00
Code Releases Activity

feat: Use makefile targets for document linting (#215)

Browse source 
This Makefile provides several targets for linting
documents. It utilizes several npm packages.
Functionality includes:

* Spellcheck
* Linting of markdown
* Check for broken links
* Sorting of dictionary file
* Detect inconsidered language

All targets (excluding the sorting of the dict file) are part
of the Github Action pipeline and will fail if quality
standards are not met.

Signed-off-by: Johannes Amorosa <johannes.amorosa@endocode.com>
This commit is contained in:
Johannes Amorosa 2020-07-05 15:37:23 +02:00 • committed by GitHub
parent f44275d4b1
commit 02caed10d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 4073 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -4,7 +4,7 @@
<hr />
<p align="center">
<a href="#about-this-project">About this Project</a> •
<a href="#about-this-project">About this Project</a> •
<a href="#who-we-are">Who We Are</a> •
<a href="#credits">Credits</a> •
<a href="#data-privacy">Data Privacy</a> •
@ -54,7 +54,7 @@ The project scope has been agreed on jointly by Deutsche Telekom AG and SAP SE a
- [Corona-Warn-App - User Interface Screens](ui_screens.md)
### Technical Documentation
The technical documents are intended for a technical audience and represent the most recent state of the architecture. The solution architecture and concepts might change over time as external dependencies (e.g. the framework provided by Apple/Google) are still changing and new requirements need to be included or existing ones change. We appreciate feedback to all elements of these technical documents.
The technical documents are intended for a technical audience and represent the most recent state of the architecture. The solution architecture and concepts might change over time as external dependencies (e.g. the framework provided by Apple/Google) are still changing and new requirements need to be included or existing ones change. We appreciate feedback to all elements of these technical documents.
* [Corona-Warn-App - Solution Architecture](solution_architecture.md)
* [Corona-Warn-App Server Architecture](https://github.com/corona-warn-app/cwa-server/blob/master/docs/ARCHITECTURE.md)
@ -80,7 +80,7 @@ For an easier understanding of the used acronyms and special terms in our docume
Copyright (c) 2020 Deutsche Telekom AG and SAP SE or an SAP affiliate company.
Licensed under the **Apache License, Version 2.0** (the "License"); you may not use this file except in compliance with the License.
Licensed under the **Apache License, Version 2.0** (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.