WIP: activate MD061 and MD044 - CMEM-8136

.rumdl.toml

@@ -0,0 +1,49 @@
+[global]
+disable = ["MD035", "MD025", "MD012", "MD041", "MD045", "MD060", "MD051", "MD046", "MD024", "MD059", "MD077", "MD036", "MD013"]
+
+[MD007]
+indent = 4
+style = "fixed"
+
+[MD030]
+ul-multi = 1
+ul-single = 1
+
+[MD033]
+allowed-elements = ["a", "br", "cite", "details", "div", "figcaption", "figure", "img", "key", "name", "p", "param", "span", "summary", "connection", "tool", "code"]
+
+[MD061]
+terms = [
+  # Höflichkeitsfloskeln / Füllwörter
+  "please", "thanks", "thank you",
+
+  # Kontraktionen: negiert
+  # "cannot" ist bewusst nicht gelistet: das ist die Standardschreibweise,
+  # keine Kontraktion - und damit das Ziel der Korrektur von "can't".
+  "don't", "doesn't", "didn't", "can't", "won't", "isn't", "aren't",
+  "wasn't", "weren't", "hasn't", "haven't", "hadn't", "shouldn't", "wouldn't",
+  "couldn't", "mustn't", "needn't",
+
+  # Kontraktionen: Verb + sein/haben/werden
+  "it's", "that's", "there's", "here's", "what's", "let's",
+  "you're", "we're", "they're", "you'll", "we'll", "they'll", "it'll",
+  "you've", "we've", "they've", "you'd", "we'd", "they'd",
+
+  "CorporateMemory"
+]
+case-sensitive = true                      # Exact case matching (default)
+
+[MD044]
+names = [
+  # Technische Bezeichner zuerst: laengere Treffer haben Vorrang und verhindern
+  # damit False Positives fuer die Markennamen weiter unten
+  # (Material-Icon-Shortcodes, Hostnamen, Umgebungsvariablen).
+  "material/github", "material/gitlab",
+  "material-github", "material-gitlab",
+  "simple-github", "simple-gitlab",
+  "gitlab.eccenca.com",
+  "COM_ECCENCA",
+
+  # Markennamen und Schreibweisen
+  "JavaScript", "GitHub", "Node.js", "TypeScript", "GitLab", "eccenca", "Corporate Memory", "eccenca Corporate Memory"
+]

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-👍🎉 First off, thanks for taking the time to contribute! 🎉👍
+👍🎉 First off, we appreciate you taking the time to contribute! 🎉👍
 
 The following is a set of guidelines for contributing to the eccenca Corporate Memory documentation project.
 
@@ -96,7 +96,7 @@ Have a look at the [mkdocs-material documentation](https://squidfunk.github.io/m
 
 ## Icons
 
-Where possible, please use icons as described on [the material for mkdocs documention](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/).
+Where possible, use icons as described on [the material for mkdocs documention](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/).
 On this page is search function for icons available as well.
 
 ## Admonitions

README.md

@@ -9,7 +9,7 @@ Shared repository of the eccenca Corporate Memory documentation.
 | `main` | [https://dev.documentation.eccenca.com](https://dev.documentation.eccenca.com) |
 | `published` | [https://documentation.eccenca.com](https://documentation.eccenca.com) |
 
-If you consider to contribute to this project, please have a look on [CONTRIBUTING.md](https://github.com/eccenca/documentation.eccenca.com/blob/main/CONTRIBUTING.md)
+If you consider to contribute to this project, have a look on [CONTRIBUTING.md](https://github.com/eccenca/documentation.eccenca.com/blob/main/CONTRIBUTING.md)
 
 ## License
 

Taskfile.yml

@@ -11,7 +11,7 @@ vars:
   MATERIAL_TAG: 9.6.14
   MATERIAL_INSIDER_TAG: 9.6.14-insiders-4.53.16
   # the markdown linter command, used by format:fix:path and check:rumdl
-  RUMDL_CHECK: poetry run rumdl --config .markdownlint.jsonc check
+  RUMDL_CHECK: poetry run rumdl --config .rumdl.toml check
   # the default lint targets: the docs tree plus the top-level markdown files
   DOCS_PATHS: ./docs ./*.md
 

docs/automate/cmemc-command-line-interface/configuration/getting-credentials-from-external-processes/index.md

@@ -28,7 +28,7 @@ export OAUTH_CLIENT_SECRET="...secret..."
 cmemc graph list
 ```
 
-In the context of a CI/CD pipeline, e.g., on github, these credentials can be taken from the repository secrets:
+In the context of a CI/CD pipeline, e.g., on GitHub, these credentials can be taken from the repository secrets:
 
 ``` yaml
 jobs:

docs/automate/cmemc-command-line-interface/invocation/github-action/index.md

@@ -1,16 +1,16 @@
 ---
-title: "cmemc: Using Github Actions"
+title: "cmemc: Using GitHub Actions"
 icon: material/github
 tags:
     - Automate
     - cmemc
 ---
-# Using Github Actions
+# Using GitHub Actions
 
 ## Introduction
 
-[Github Actions](https://docs.github.com/en/actions) allow for the automation and execution of workflows based on pushes, merge requests and other trigger events to your git repository.
-In order to control eccenca Corporate Memory instances from within Github Action based workflows, you need to provide cmemc as well as credentials for your instance to the workflow.
+[GitHub Actions](https://docs.github.com/en/actions) allow for the automation and execution of workflows based on pushes, merge requests and other trigger events to your git repository.
+In order to control eccenca Corporate Memory instances from within GitHub Action based workflows, you need to provide cmemc as well as credentials for your instance to the workflow.
 
 ## Runner Provisioning
 
@@ -34,7 +34,7 @@ Adding the above to your workflow yaml description will provide a cmemc command
 ## Credentials and Usage
 
 Since we should never save credentials in your repository, we need to provide them as an encrypted secret managed outside of the repository.
-Github provides you with an [Encrypted Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) interface where you can add secrets for your repository, which in turn can be used in your workflows.
+GitHub provides you with an [Encrypted Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) interface where you can add secrets for your repository, which in turn can be used in your workflows.
 
 Given the following workflow step, you need to add `MY_CMEM_BASE_URI`, `MY_OAUTH_GRANT_TYPE`, `MY_OAUTH_CLIENT_ID` and `MY_OAUTH_CLIENT_SECRET` as encrypted secrets to your repository:
 
@@ -56,7 +56,7 @@ The above snippet also demonstrates how you can map your encrypted secrets to [c
 
 ## Example Project
 
-The Github project [eccenca/cmemc-workflow](https://github.com/eccenca/cmemc-workflow) provides an [example workflow description](https://github.com/eccenca/cmemc-workflow/blob/main/.github/workflows/cmemc.yml) which uses cmemc to import a graph, count the triples and removes the graph afterwards.
+The GitHub project [eccenca/cmemc-workflow](https://github.com/eccenca/cmemc-workflow) provides an [example workflow description](https://github.com/eccenca/cmemc-workflow/blob/main/.github/workflows/cmemc.yml) which uses cmemc to import a graph, count the triples and removes the graph afterwards.
 Here is an example output:
 
 ![Example workflow output](example-workflow-output.png "Example workflow output")

docs/automate/cmemc-command-line-interface/invocation/gitlab-pipeline/index.md

@@ -1,20 +1,20 @@
 ---
-title: "cmemc: Using Gitlab Pipelines"
+title: "cmemc: Using GitLab Pipelines"
 icon: material/gitlab
 tags:
   - Automate
   - cmemc
 ---
-# Using Gitlab Pipelines
+# Using GitLab Pipelines
 
 ## Introduction
 
-[Gitlab CI/CD](https://docs.gitlab.com/ee/topics/build_your_application.html) allows for the automation and execution of workflows based on pushes, merge requests and other trigger events to your git repository.
-In order to control eccenca Corporate Memory instances from within Gitlab CI/CD based workflows you need to provide cmemc and the credentials for your instance to the Gitlab CI/CD pipeline.
+[GitLab CI/CD](https://docs.gitlab.com/ee/topics/build_your_application.html) allows for the automation and execution of workflows based on pushes, merge requests and other trigger events to your git repository.
+In order to control eccenca Corporate Memory instances from within GitLab CI/CD based workflows you need to provide cmemc and the credentials for your instance to the GitLab CI/CD pipeline.
 
 ## Runner Provisioning
 
-In order to use cmemc in Gitlab pipelines you can use the [cmemc docker image](../docker-image/index.md).
+In order to use cmemc in GitLab pipelines you can use the [cmemc docker image](../docker-image/index.md).
 
 ```yaml title="Partial .gitlab-ci.yml showing cmemc provisioning"
 test:
@@ -30,7 +30,7 @@ Adding the above to your pipeline description will provide a cmemc command which
 ## Credentials and Usage
 
 Since we should never commit credentials in your repository, we need to provide them as an encrypted secret managed outside of the repository.
-You can add [CI/CD variables](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project) to a project’s settings directly in Gitlab.
+You can add [CI/CD variables](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project) to a project’s settings directly in GitLab.
 
 Given the following pipeline step, you need to add `MY_CMEM_BASE_URI`, `MY_OAUTH_GRANT_TYPE`, `MY_OAUTH_CLIENT_ID` and `MY_OAUTH_CLIENT_SECRET` as encrypted secrets to your repository:
 
@@ -57,7 +57,7 @@ The above snippet also demonstrates how you can map your project variables to [c
 
 ## Example Project
 
-The Github project [eccenca/cmemc-workflow](https://github.com/eccenca/cmemc-workflow) provides an [example gitlab pipeline description](https://github.com/eccenca/cmemc-workflow/blob/main/.gitlab-ci.yml) which uses cmemc to import a graph, count the triples and removes the graph afterwards.
+The GitHub project [eccenca/cmemc-workflow](https://github.com/eccenca/cmemc-workflow) provides an [example GitLab pipeline description](https://github.com/eccenca/cmemc-workflow/blob/main/.gitlab-ci.yml) which uses cmemc to import a graph, count the triples and removes the graph afterwards.
 Here is an example output:
 
 ![Example pipeline output](example-pipeline-output.png "Example pipeline output")

docs/automate/cmemc-command-line-interface/invocation/index.md

@@ -14,9 +14,9 @@ Besides the plain ad-hoc invocation from a users terminal, the following recipes
 
 - :material-docker: Executing cmemc as a [Docker Container](docker-image/index.md).
 
-- :material-github: Running cmemc jobs as part of [Github Actions](github-action/index.md).
+- :material-github: Running cmemc jobs as part of [GitHub Actions](github-action/index.md).
 
-- :material-gitlab: Running cmemc jobs as part of [Gitlab Pipelines](gitlab-pipeline/index.md).
+- :material-gitlab: Running cmemc jobs as part of [GitLab Pipelines](gitlab-pipeline/index.md).
 
 - :eccenca-application-queries: Preparing [SPARQL Scripts](sparql-scripts/index.md) to fetch data from your Knowledge Graphs.
 

docs/automate/cmemc-command-line-interface/scripting-with-cmemc/index.md

@@ -167,4 +167,4 @@ Refer to [Environment-based Configuration](../configuration/environment-based-co
 
 - [Workflow Execution and Orchestration](../workflow-execution-and-orchestration/index.md) - a complete example script which starts workflows in parallel and waits for the results.
 - [Backup and Restore](../backup-and-restore/index.md) - creating and restoring backup artifacts with cmemc.
-- [Using Gitlab Pipelines](../invocation/gitlab-pipeline/index.md) and [Using Github Actions](../invocation/github-action/index.md) - running cmemc on a build server.
+- [Using GitLab Pipelines](../invocation/gitlab-pipeline/index.md) and [Using GitHub Actions](../invocation/github-action/index.md) - running cmemc on a build server.

docs/automate/cmemc-command-line-interface/troubleshooting-and-caveats/index.md

@@ -54,7 +54,7 @@ $ cmemc -c my-cmem project import my-project.zip my-project
 Import file my-project.zip to project my-project ... 504 Server Error: Gateway Time-out for url: https://my-cmem/dataintegration/workspace/projects
 ```
 
-This can have multiple reasons - please check in the following order:
+This can have multiple reasons - check in the following order:
 
 - `application.yaml` of DataIntegration
 - reverse proxy configuration

docs/automate/cmemc-command-line-interface/workflow-execution-and-orchestration/index.md

@@ -44,7 +44,7 @@ $ cmemc workflow execute cmem:my-workflow --wait
 cmem:my-workflow ... Started ... Finished (Finished in 32.931s, just now)
 ```
 
-For a reference of the `workflow execute` command, please have a look at the [Command Reference](../command-reference/index.md) or the command-specific help (`cmemc workflow execute --help`).
+For a reference of the `workflow execute` command, have a look at the [Command Reference](../command-reference/index.md) or the command-specific help (`cmemc workflow execute --help`).
 
 ## Retrieve Status Information
 
@@ -80,7 +80,7 @@ $ cmemc workflow status cmem:my-workflow --raw
 }
 ```
 
-For a reference of the `workflow status` command, please have a look at the [Command Reference](../command-reference/index.md) or the command-specific help (`cmemc workflow status --help`).
+For a reference of the `workflow status` command, have a look at the [Command Reference](../command-reference/index.md) or the command-specific help (`cmemc workflow status --help`).
 
 ## Serial Execution
 

docs/automate/continuous-integration/index.md

@@ -33,8 +33,8 @@ The following pages provide recipes for different CI/CD solutions:
 
 <div class="grid cards" markdown>
 
-- :material-github: [Github Actions](../cmemc-command-line-interface/invocation/github-action/index.md)
+- :material-github: [GitHub Actions](../cmemc-command-line-interface/invocation/github-action/index.md)
 
-- :material-gitlab: [Gitlab Pipelines](../cmemc-command-line-interface/invocation/gitlab-pipeline/index.md)
+- :material-gitlab: [GitLab Pipelines](../cmemc-command-line-interface/invocation/gitlab-pipeline/index.md)
 
 </div>

docs/build/loading-jdbc-datasets-incrementally/index.md

@@ -67,7 +67,7 @@ To incrementally extract data in Corporate Memory, we need to store the informat
 ### To find the JDBC endpoint IRI
 
 1. Visit the **Exploration** Tab of Corporate Memory
-2. Select in Graph (top left) your project, which starts with "**CMEM DI Project** ... " (if you cannot see it, you might not have the necessary access rights. In this case, please contact your administrator)
+2. Select in Graph (top left) your project, which starts with "**CMEM DI Project** ... " (if you cannot see it, you might not have the necessary access rights. In this case, contact your administrator)
 3. Select in Navigation (bottom left): **functions_Plugins_Jdbc**
 4. Select the previously created JDBC endpoint (in our example: "Services Table (JDBC)"
 5. Press the **Turtle** tab inside your JDBC endpoint view (right)
@@ -182,7 +182,7 @@ Finally, we can build a Workflow which demonstrates how each step works.
 We compose the SQL query based on the OFFSET and LIMIT information in our Metadata Graph.
 This SQL query will be used to configure the sourceQuery of the JDBC endpoint.
 Next, we do a "regular" transformation of data from a JDBC endpoint to RDF.
-As this step was omitted here, please feel free to read how this Transformation can be built here: [Lift data from tabular data such as CSV, XSLX or database tables](../../build/lift-data-from-tabular-data-such-as-csv-xslx-or-database-tables/index.md).
+As this step was omitted here, feel free to read how this Transformation can be built here: [Lift data from tabular data such as CSV, XSLX or database tables](../../build/lift-data-from-tabular-data-such-as-csv-xslx-or-database-tables/index.md).
 As a final step, we use our SPARQL update query to select the max service ID in our Knowledge Graph and update the RDF Triples in our Metadata Graph accordingly.
 
 ![Workflow using config part for incremental data loading](incr-jdbc-complete-wf.png){ class="bordered" }

docs/build/mapping-creator/index.md

@@ -120,7 +120,7 @@ Accept (:octicons-thumbsup-16:) or reject (:octicons-thumbsdown-16:) each sugges
 
 ![Smart Class Suggestions](mapping-creator-class-suggestion.png){ class="bordered" }
 
-If you haven't selected a target class yet, the AI will suggest classes from the selected vocabularies that best fit your source data.
+If you have not selected a target class yet, the AI will suggest classes from the selected vocabularies that best fit your source data.
 Alternatively, you can search for classes manually by typing text into the search field.
 
 Hover over the wand icon for each suggestion to understand why this class has been recommended.

docs/build/snowflake-tutorial/index.md

@@ -20,7 +20,7 @@ This connection allows organizations to store and manage large amounts of data i
 By integrating Snowflake with eccenca Corporate Memory, organizations can achieve a centralized and unified data management system that allows them to gain a complete and accurate view of all their data assets.
 This integration enables organizations to make informed decisions, improve their business processes, and drive growth and innovation by leveraging their data assets.
 
-This tutorial contains the following step-by-step instructions to connect the Snowflake data-warehouse with eccenca corporate memory:
+This tutorial contains the following step-by-step instructions to connect the Snowflake data-warehouse with eccenca Corporate Memory:
 
 - [1. Create a database in Snowflake](#1-create-a-database-in-snowflake)
 - [2. Create a project in eccenca Corporate Memory](#2-create-a-project-in-eccenca-corporate-memory)