Spellchecking

.github/actions/spelling/advice.md

@@ -0,0 +1,7 @@
+<!-- markdownlint-disable MD033 MD041 -->
+<details>
+<summary>
+:pencil2: Contributor please read this
+</summary>
+
+Thank you for contributing :fire:

.github/actions/spelling/allow/allow.txt

@@ -0,0 +1,21 @@
+IDSA
+refactor
+keystore
+Wiki
+wiki
+roadmap
+Kubernetes
+bugfix
+tbd
+PostgreSQL
+URL
+URLs
+Uninstall
+kubectl
+Minikube
+Helm
+username
+namespace
+href
+src
+img

.github/actions/spelling/excludes.txt

@@ -0,0 +1,17 @@
+\.avi$
+\.json$
+\.p12$
+\.env$
+^\.github/
+\.ico$
+ignore$
+\.jpe?g$
+\.lock$
+\.map$
+\.min\.
+\.mod$
+\.mp[34]$
+\.png$
+\.wav$
+\.yml$
+\.yaml$

.github/actions/spelling/expect/expect.txt

@@ -0,0 +1,4 @@
+SSL
+api
+readme
+changelog

.github/actions/spelling/expect/web.txt

@@ -0,0 +1,2 @@
+http
+www

.github/actions/spelling/patterns/patterns.txt

@@ -0,0 +1,21 @@
+# ignore long runs of a single character:
+\b([A-Za-z])\g{-1}{3,}\b
+https://(?:[a-z-]+\.|)github(?:usercontent|)\.com/[-a-zA-Z0-9?%&=_\/.]*
+https://(?:[a-z-]+\.|)github\.io/[-a-zA-Z0-9?%&=_\/.]*
+https://(?:(?:[-a-zA-Z0-9?&=]*\.|)internationaldataspaces\.org)/[-a-zA-Z0-9?&=_#\/.]*
+https://deepsource.io/blog/git-branch-naming-conventions/
+https://www.conventionalcommits.org/en/v1.0.0/
+https://(?:(?:[-a-zA-Z0-9?&=]*\.|)dataspace-connector\.de)/[-a-zA-Z0-9?&=_#\/.]*
+Dataspace Connector
+dataspace-connector
+Metadata Broker
+http://keepachangelog.com
+`/dataspaceconnector/config/`
+`config.json`
+export POD_NAME=\$\((.*?)\)
+export CONTAINER_PORT=\$\((.*?)\)
+helm install dataspaceconnector charts/dataspace-connector
+helm uninstall dataspaceconnector
+https://localhost:8080/api/docs
+http://localhost:8081/swagger-ui/index\.html\?url=/v3/api-docs/
+http://localhost:8082/dashboard

.github/workflows/spelling.yml

@@ -0,0 +1,19 @@
+name: Spell checking
+on:
+  pull_request_target:
+  push:
+
+jobs:
+  build:
+    name: Spell checking
+    runs-on: ubuntu-latest
+    steps:
+    - name: checkout-merge
+      if: "contains(github.event_name, 'pull_request')"
+      uses: actions/[email protected]
+      with:
+        ref: refs/pull/${{github.event.pull_request.number}}/merge
+    - name: checkout
+      if: "!contains(github.event_name, 'pull_request')"
+      uses: actions/[email protected]
+    - uses: check-spelling/[email protected]

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 2021-06-22
+
+### Added
+- Add spell checking
+
 ## 2021-06-16
 
 ### Added

README.md

@@ -19,7 +19,7 @@ The IDS Deployment Examples Repository is used to provide working deployments ac
 ## Overview
 
 The repository is organized as follows: 
-* Per component or component bundle (union from e.g. Dataspace Connector and Metadata broker or Dataspace Connector and Trusted Connector) a folder is created. This again contains possibly independent Variatonen for e.g. minimal/full Setups or Helm/Kubernetes/Docker Setups.
+* Per component or component bundle (union from e.g. Dataspace Connector and Metadata Broker or Dataspace Connector and Trusted Connector) a folder is created. This again contains possibly independent variations for e.g. minimal/full Setups or Helm/Kubernetes/Docker Setups.
 * Additionally there is a templates folder, which provides templates for the Deployment Examples.
 
 

dataspace-connector/README.md

@@ -8,9 +8,9 @@
 
 This folder provides examples to set up the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector).
 We distinguish between three categories:
-1. **Full Setup**: The [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) is started with all its extensions, i.e. [Configmanager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager), [GUI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI), [Camel](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance), Postgres DB.
+1. **Full Setup**: The [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) is started with all its extensions, i.e. [ConfigurationManager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager), [GUI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI), [Camel](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance), PostgreSQL DB.
 2. **Provider-Consumer Setup**: Here two [Dataspace Connectors](https://github.com/International-Data-Spaces-Association/DataspaceConnector) are started, so that data can be exchanged between them. (**tbd.**)
-3. **Slim Setup**: In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and Postgres as database are started, without Camel, Configmanager and GUI.
+3. **Slim Setup**: In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and PostgreSQL as database are started, without Camel, ConfigurationManager and GUI.
 
 For more details see here: [Dataspace Connector Architecture](https://international-data-spaces-association.github.io/DataspaceConnector/Documentation/Architecture)
 

dataspace-connector/full/README.md

@@ -20,7 +20,7 @@ Other than described there, in this example, the `config.json` and the `KeyStore
 In this setup, the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) is started with the listed extensions:
 * [Configuration Manager](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager), 
 * [Configuration Manager GUI](https://github.com/International-Data-Spaces-Association/IDS-ConfigurationManager-UI), 
-* Postgres DB
+* PostgreSQL DB
 
 In addition, the following Dataspace Connector extensions will be included in future deployment example setups:
 * [Camel](https://github.com/International-Data-Spaces-Association/DSC-Camel-Instance)
@@ -34,7 +34,7 @@ This deployment example builds on the following compatible versions:
 | Dataspace Connector | 4.3.1 |
 | Configuration Manager | 7.0.0 |
 | Configuration Manager GUI | 7.0.1 |
-| Postgres | 12 |
+| PostgreSQL | 12 |
 
 ### Prerequisites
   - Git

dataspace-connector/slim/README.md

@@ -7,7 +7,7 @@
 </h1>
 
 This is the **Slim Setup** of the Dataspace Connector.
-In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and Postgres as database are started, without Camel, Configmanager and UI.
+In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and PostgreSQL as database are started, without Camel, ConfigurationManager and UI.
 
 This allows us to only using the core functionalities of the Dataspace Connector without having an graphical user interface and the logic of the ConfigurationManager to install IDS Apps and configure Camel routes.
 

dataspace-connector/slim/docker/README.md

@@ -7,7 +7,7 @@
 </h1>
 
 This is a deployment example for the **Slim Setup** of the Dataspace Connector.
-In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and Postgres as database are started, without Camel, Configmanager and UI.
+In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and PostgreSQL as database are started, without Camel, ConfigurationManager and UI.
 
 This allows us to only using the core functionalities of the Dataspace Connector without having an graphical user interface and the logic of the ConfigurationManager to install IDS Apps and configure Camel routes.
 
@@ -26,7 +26,7 @@ This Dataspace Connector Deployment example consists of the following components
 | Component | Version |
 |:----------|:--------|
 | Dataspace Connector | latest |
-| Postgres | 13 |
+| PostgreSQL | 13 |
 
 ### Prerequisites
   - Git
@@ -38,7 +38,7 @@ This Dataspace Connector Deployment example consists of the following components
     ```
     git clone https://github.com/International-Data-Spaces-Association/IDS-Deployment-Examples.git
     ```
-2. Open a new terminal inside the created direcotry and navigate to this folder.
+2. Open a new terminal inside the created directory and navigate to this folder.
     ```
     cd IDS-Deployment-Examples/dataspace-connector/slim/docker
     ``` 

dataspace-connector/slim/k8s/README.md

@@ -7,13 +7,13 @@
 </h1>
 
 This is the **Slim Setup** of the Dataspace Connector.
-In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and Postgres as database are started, without Camel, Configmanager and UI.
+In this setup only the [Dataspace Connector](https://github.com/International-Data-Spaces-Association/DataspaceConnector) and PostgreSQL as database are started, without Camel, ConfigurationManager and UI.
 
 This allows us to only using the core functionalities of the Dataspace Connector without having an graphical user interface and the logic of the ConfigurationManager to install IDS Apps and configure Camel routes.
 
 ## Deployment Example
 This Dataspace Connector Deployment example consists of the following components:
-- Postgres 13
+- PostgreSQL 13
 - Dataspace Connector latest
 
 ---
@@ -23,9 +23,9 @@ This example can not be used with the current IDS Metadata Broker off-the-shelf,
 
 ---
 ### Prerequisites
-  - git
-  - minikube
-  - helm
+  - Git
+  - Minikube
+  - Helm
 
 ### Install Steps
   - Clone the Dataspace Connector repo 
@@ -40,7 +40,7 @@ This example can not be used with the current IDS Metadata Broker off-the-shelf,
     ```
     helm install dataspaceconnector charts/dataspace-connector
     ```
-  - Follow the instructings for connecting to the service displayed in the terminal e.g.:
+  - Follow the instructions for connecting to the service displayed in the terminal e.g.:
     ```
     1. Get the application URL by running these commands:
     export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=dataspace-connector,app.kubernetes.io/instance=dataspaceconnector" -o jsonpath="{.items[0].metadata.name}")
@@ -51,7 +51,7 @@ This example can not be used with the current IDS Metadata Broker off-the-shelf,
   - Login with username `admin` and password `password`
   - The [Communication Guide](https://international-data-spaces-association.github.io/DataspaceConnector/CommunicationGuide) explains how to use the APIs of the connector
 
-Individual settings can be made by modifing the chart itself.
+Individual settings can be made by modifying the chart itself.
 
 ### Uninstall
   - Run `helm uninstall dataspaceconnector`