mirror of
https://github.com/corona-warn-app/cwa-documentation
synced 2024-11-22 09:14:26 +01:00
Remove markdown-spellcheck
This commit is contained in:
parent
0011ed3284
commit
9f7f33b3db
5
.github/workflows/checks.yml
vendored
5
.github/workflows/checks.yml
vendored
@ -34,11 +34,6 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
npm run-script checklinks
|
npm run-script checklinks
|
||||||
|
|
||||||
#- name: Spellchecking english
|
|
||||||
# if: always()
|
|
||||||
# run: |
|
|
||||||
# npm run-script spellcheck
|
|
||||||
|
|
||||||
#- name: Detect inconsiderate language
|
#- name: Detect inconsiderate language
|
||||||
# if: always()
|
# if: always()
|
||||||
# run: |
|
# run: |
|
||||||
|
123
.spelling
123
.spelling
@ -1,123 +0,0 @@
|
|||||||
14-day
|
|
||||||
24-hour
|
|
||||||
alex
|
|
||||||
amongst
|
|
||||||
analytics
|
|
||||||
APIs
|
|
||||||
APNs
|
|
||||||
backend
|
|
||||||
Backend
|
|
||||||
barcode
|
|
||||||
barcodes
|
|
||||||
BlackDuck
|
|
||||||
blacklist
|
|
||||||
broadcasted
|
|
||||||
Bundesbeauftragter
|
|
||||||
Bundesnetzagentur
|
|
||||||
changelog
|
|
||||||
Changelog
|
|
||||||
changelogs
|
|
||||||
Changelogs
|
|
||||||
Checkmarx
|
|
||||||
commonmark
|
|
||||||
Commonmark
|
|
||||||
config
|
|
||||||
Config
|
|
||||||
coronavirus
|
|
||||||
Covid-19
|
|
||||||
cwa-app-android
|
|
||||||
cwa-app-ios
|
|
||||||
cwa-server
|
|
||||||
cwa-testresult-server
|
|
||||||
cwa-verification-iam
|
|
||||||
cwa-verification-portal
|
|
||||||
cwa-verification-server
|
|
||||||
CxSAST
|
|
||||||
cyber
|
|
||||||
Cyber
|
|
||||||
DDoS
|
|
||||||
deanonymize
|
|
||||||
Deutsche
|
|
||||||
DP-3T
|
|
||||||
e.g.
|
|
||||||
en_US
|
|
||||||
epidemiologically
|
|
||||||
flyer
|
|
||||||
focussing
|
|
||||||
Gesundheitsamt
|
|
||||||
hacktivism
|
|
||||||
hardcoded
|
|
||||||
Hardcoded
|
|
||||||
how-tos
|
|
||||||
i.e.
|
|
||||||
IfSG
|
|
||||||
Informationsfreiheit
|
|
||||||
Infrastrukturen
|
|
||||||
iOS
|
|
||||||
Kritische
|
|
||||||
lifecycle
|
|
||||||
Lifecycle
|
|
||||||
linter
|
|
||||||
linters
|
|
||||||
logfile
|
|
||||||
logfiles
|
|
||||||
macOS
|
|
||||||
markdownlint.json
|
|
||||||
metadata
|
|
||||||
Metadata
|
|
||||||
misconfiguration
|
|
||||||
natively
|
|
||||||
npm
|
|
||||||
onboarding
|
|
||||||
Onboarding
|
|
||||||
package.json
|
|
||||||
PEPP-PT
|
|
||||||
PostgreSQL
|
|
||||||
pre-printed
|
|
||||||
Probenbegleitschein
|
|
||||||
Protecode
|
|
||||||
pseudonymized
|
|
||||||
rebase
|
|
||||||
reinstall
|
|
||||||
reinstalls
|
|
||||||
remediate
|
|
||||||
Remediate
|
|
||||||
resize
|
|
||||||
RPIs
|
|
||||||
SafetyNet
|
|
||||||
sap.com
|
|
||||||
Sarbanes-Oxley
|
|
||||||
SARS-CoV-2
|
|
||||||
sexualized
|
|
||||||
socio-economic
|
|
||||||
SonarQube
|
|
||||||
Synopsys
|
|
||||||
TalkBack
|
|
||||||
TEK
|
|
||||||
TEKs
|
|
||||||
Telekom
|
|
||||||
teleTAN
|
|
||||||
TeleTAN
|
|
||||||
teleTANs
|
|
||||||
TeleTANs
|
|
||||||
timeframe
|
|
||||||
timestamp
|
|
||||||
timestamping
|
|
||||||
Timestamping
|
|
||||||
tl
|
|
||||||
tl;dr
|
|
||||||
Tx
|
|
||||||
UI
|
|
||||||
uninstallation
|
|
||||||
Uninstallation
|
|
||||||
unlinkability
|
|
||||||
Unlinkability
|
|
||||||
unobservability
|
|
||||||
Unobservability
|
|
||||||
unsecure
|
|
||||||
up-to-dateness
|
|
||||||
useable
|
|
||||||
versioning
|
|
||||||
Vulas
|
|
||||||
whitelist
|
|
||||||
WhiteSource
|
|
41
INSTALL.md
41
INSTALL.md
@ -10,7 +10,6 @@
|
|||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Linting of markdown documents
|
* Linting of markdown documents
|
||||||
* Spell checking
|
|
||||||
* Link checking
|
* Link checking
|
||||||
|
|
||||||
## Specifications
|
## Specifications
|
||||||
@ -19,12 +18,6 @@ This repository checks against following specification:
|
|||||||
|
|
||||||
* [Markdown Commonmark](https://spec.commonmark.org/)
|
* [Markdown Commonmark](https://spec.commonmark.org/)
|
||||||
|
|
||||||
### Languages
|
|
||||||
|
|
||||||
Supported languages are:
|
|
||||||
|
|
||||||
* [English US](https://en.wikipedia.org/wiki/ISO/IEC_8859-1)
|
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Install the Node.js 16 Active LTS version of [Node.js](https://nodejs.org/en/) (which includes npm).
|
Install the Node.js 16 Active LTS version of [Node.js](https://nodejs.org/en/) (which includes npm).
|
||||||
@ -41,7 +34,7 @@ This installs all dependencies into a local `node_modules` folder.
|
|||||||
|
|
||||||
## Checks
|
## Checks
|
||||||
|
|
||||||
To enforce good spelling and specification conformity there are several checks defined as `npm run-script` targets. To run all checks please execute:
|
To enforce specification conformity there are several checks defined as `npm run-script` targets. To run all checks please execute:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
npm test
|
npm test
|
||||||
@ -53,7 +46,7 @@ If you want to run individual checks see the targets and the description below.
|
|||||||
Every individual check can be run like so:
|
Every individual check can be run like so:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
npm runscript my-individual-check
|
npm run-script my-individual-check
|
||||||
```
|
```
|
||||||
|
|
||||||
See the [package.json](package.json) file for the currently available scripts.
|
See the [package.json](package.json) file for the currently available scripts.
|
||||||
@ -68,7 +61,7 @@ npm run-script markdownlint
|
|||||||
|
|
||||||
##### Markdown linter overrides
|
##### Markdown linter overrides
|
||||||
|
|
||||||
Sometimes it is not possible to be commonmark conform. In this rare cases an inline tag to skip linting is possible.
|
Sometimes it is not possible to be commonmark conform. In these rare cases an inline tag to skip linting is possible.
|
||||||
|
|
||||||
Candidates are tables.
|
Candidates are tables.
|
||||||
|
|
||||||
@ -99,32 +92,6 @@ like this:
|
|||||||
For more information how to tweak overrides consult the markdown linter
|
For more information how to tweak overrides consult the markdown linter
|
||||||
documentation mentioned above.
|
documentation mentioned above.
|
||||||
|
|
||||||
#### Spell checker
|
|
||||||
|
|
||||||
##### English
|
|
||||||
|
|
||||||
Spell checking in American English (en_US).
|
|
||||||
|
|
||||||
```shell
|
|
||||||
npm run-script spellcheck
|
|
||||||
```
|
|
||||||
|
|
||||||
##### German
|
|
||||||
|
|
||||||
Not implemented yet.
|
|
||||||
|
|
||||||
##### Spell checker overrides
|
|
||||||
|
|
||||||
Add any additional words to the .spelling file and use the target to sort and
|
|
||||||
clean them before adding these to master.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
npm run-script format-spelling
|
|
||||||
```
|
|
||||||
|
|
||||||
Please note sometimes overriding is not the way to go. Our terminology should be
|
|
||||||
applied consistently.
|
|
||||||
|
|
||||||
#### Link resolver
|
#### Link resolver
|
||||||
|
|
||||||
All cross references and external URLs are resolved.
|
All cross references and external URLs are resolved.
|
||||||
@ -135,7 +102,7 @@ npm run-script checklinks
|
|||||||
|
|
||||||
#### Inconsiderate language scanner
|
#### Inconsiderate language scanner
|
||||||
|
|
||||||
This checks against profanity and inconsiderate language. This is help full for
|
This checks against profanity and inconsiderate language. This is helpful for
|
||||||
non-natives to detect words that could be inconsiderate. This utilizes [alex](https://github.com/get-alex/alex)
|
non-natives to detect words that could be inconsiderate. This utilizes [alex](https://github.com/get-alex/alex)
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
1192
package-lock.json
generated
1192
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
10
package.json
10
package.json
@ -1,24 +1,20 @@
|
|||||||
{
|
{
|
||||||
"name": "docs",
|
"name": "docs",
|
||||||
"version": "1.0.0",
|
"version": "1.1.0",
|
||||||
"description": "Corona-Warn-App: Documentation repository",
|
"description": "Corona-Warn-App: Documentation repository",
|
||||||
"main": "README.md",
|
"main": "README.md",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"alex": "^8.2.0",
|
"alex": "^8.2.0",
|
||||||
"markdown-link-check": "^3.8.1",
|
"markdown-link-check": "^3.8.1",
|
||||||
"markdown-spellcheck": "^1.3.1",
|
|
||||||
"markdownlint": "^0.20.4",
|
"markdownlint": "^0.20.4",
|
||||||
"markdownlint-cli": "^0.23.2",
|
"markdownlint-cli": "^0.23.2",
|
||||||
"npm-run-all": "^4.1.5"
|
"npm-run-all": "^4.1.5"
|
||||||
},
|
},
|
||||||
"devDependencies": {},
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "run-s markdownlint checklinks format-spelling",
|
"test": "run-s markdownlint checklinks",
|
||||||
"spellcheck": "mdspell '**/*.md' --en-us -t -n -a --report '!**/node_modules/**/*.md' '!**/.github/**/*.md' '!**/translations/**/*.md'",
|
|
||||||
"markdownlint": "markdownlint '**/*.md' --ignore node_modules",
|
"markdownlint": "markdownlint '**/*.md' --ignore node_modules",
|
||||||
"checklinks": "find . -not -path \"*node_modules*\" -not -path \"*.github*\" -name \"*.md\" | xargs -n 1 markdown-link-check",
|
"checklinks": "find . -not -path \"*node_modules*\" -not -path \"*.github*\" -name \"*.md\" | xargs -n 1 markdown-link-check",
|
||||||
"detect-inconsiderate-language": "alex",
|
"detect-inconsiderate-language": "alex"
|
||||||
"format-spelling": "sort < .spelling | sort | uniq | tee .spelling.tmp > /dev/null && mv .spelling.tmp .spelling"
|
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
|
Loading…
Reference in New Issue
Block a user