docs: remove absolute markdown urls (#523)

sovity · Sep 8, 2023 · 2e27c70 · 2e27c70
1 parent 0a5886d
commit 2e27c70
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 35 deletions.
diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md
@@ -16,9 +16,9 @@ Feel free to edit this release checklist in-progress depending on what tasks nee
 - [ ] Decide a release version depending on major/minor/patch changes in the CHANGELOG.md.
 - [ ] Update this issue's title to the new version
 - [ ] `release-prep` PR:
-    - [ ] Write or review the current [Productive Deployment Guide](/docs/deployment-guide/goals/production)
-    - [ ] Write or review the current [Development Deployment Guide](/docs/deployment-guide/goals/development)
-    - [ ] Write or review the current [Local Demo Deployment Guide](/docs/deployment-guide/goals/local-demo)
+    - [ ] Write or review the current [Productive Deployment Guide](https://github.com/sovity/edc-extensions/blob/main/docs/deployment-guide/goals/production)
+    - [ ] Write or review the current [Development Deployment Guide](https://github.com/sovity/edc-extensions/blob/main/docs/deployment-guide/goals/development)
+    - [ ] Write or review the current [Local Demo Deployment Guide](https://github.com/sovity/edc-extensions/blob/main/docs/deployment-guide/goals/local-demo)
     - [ ] Update the CHANGELOG.md.
         - [ ] Add a clean `Unreleased` version.
         - [ ] Add the version to the old section.

diff --git a/.github/markdown-link-checker-config.jq → .github/markdown-link-checker-config.json b/.github/markdown-link-checker-config.jq → .github/markdown-link-checker-config.json
@@ -1,4 +1,3 @@
-#!/usr/bin/env -S jq -nf
 {
   "ignorePatterns": [
     {"pattern": "^https?://localhost"},
@@ -7,11 +6,5 @@
     {"pattern": "^https://www\\.linkedin\\.com"},
     {"pattern": "https://(.*?)\\.azure\\.sovity\\.io"},
     {"pattern": "http://edc2?:"}
-  ],
-  "replacementPatterns": [
-    {
-      "pattern": "^/",
-      "replacement": "https://github.com/sovity/edc-extensions/blob/\(env | .CI_SHA // ("CI_SHA was null" | halt_error))/"
-    }
   ]
 }
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -187,11 +187,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master
-      - uses: FranzDiebold/github-env-vars-action@v2
-      - name: "Markdown Link Checker: Generate Config"
-        run: .github/markdown-link-checker-config.jq > .github/markdown-link-checks-config.json
       - name: "Markdown Link Checker: Validate Links"
         uses: gaurav-nelson/github-action-markdown-link-check@v1
         with:
           use-quiet-mode: 'yes'
-          config-file: '.github/markdown-link-checks-config.json'
+          config-file: '.github/markdown-link-checker-config.json'
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -31,17 +31,17 @@
 
 ## Extensions
 
-* [API Wrapper](/extensions/wrapper/README.md)
-    * [API Commons Endpoint](/extensions/wrapper/wrapper-common-api/README.md)
-    * [API EE Endpoint](/extensions/wrapper/wrapper-ee-api/README.md)
-    * [Java Implementation](/extensions/wrapper/client/README.md)
-    * [Java Example](/extensions/wrapper/client-example/README.md)
-    * [TypeScript Implementation](/extensions/wrapper/client-ts/README.md)
-    * [TypeScript Example](/extensions/wrapper/client-ts-example/README.md)
+* [API Wrapper](./extensions/wrapper/README.md)
+    * [API Commons Endpoint](./extensions/wrapper/wrapper-common-api/README.md)
+    * [API EE Endpoint](./extensions/wrapper/wrapper-ee-api/README.md)
+    * [Java Implementation](./extensions/wrapper/client/README.md)
+    * [Java Example](./extensions/wrapper/client-example/README.md)
+    * [TypeScript Implementation](./extensions/wrapper/client-ts/README.md)
+    * [TypeScript Example](./extensions/wrapper/client-ts-example/README.md)
 * [Policies]()
-    * [Always True](/extensions/policy-always-true/README.md)
-    * [Referring Connector](/extensions/policy-referring-connector/README.md)
-    * [Time Interval](/extensions/policy-time-interval/README.md)
-* [Database Migration](/extensions/postgres-flyway/README.md)
-* [EDC UI Config](/extensions/edc-ui-config/README.md)
-* [Last Commit Info](/extensions/last-commit-info/README.md)
+    * [Always True](./extensions/policy-always-true/README.md)
+    * [Referring Connector](./extensions/policy-referring-connector/README.md)
+    * [Time Interval](./extensions/policy-time-interval/README.md)
+* [Database Migration](./extensions/postgres-flyway/README.md)
+* [EDC UI Config](./extensions/edc-ui-config/README.md)
+* [Last Commit Info](./extensions/last-commit-info/README.md)
diff --git a/docs/deployment-guide/goals/production/4.2.0/README.md b/docs/deployment-guide/goals/production/4.2.0/README.md
@@ -17,13 +17,13 @@ to technical reasons, reachability via the internet and well-defined URLs across
 
 To deploy an EDC multiple deployment units must be deployed and configured.
 
-| Deployment Unit                                                | Version / Details                                                                |
-|----------------------------------------------------------------|----------------------------------------------------------------------------------|
-| An Auth Proxy / Auth solution of your choice.                  | (deployment specific, required to secure UI and management API)                  |
-| Reverse Proxy that merges the UI+Backend and removes the ports | (deployment specific)                                                            |
-| Postgresql                                                     | 13 or compatible version                                                         |
-| EDC Backend                                                    | edc-ce or edc-ce-mds, see [CHANGELOG.md](/CHANGELOG.md) for compatible versions. |
-| EDC UI                                                         | edc-ui, see  [CHANGELOG.md](/CHANGELOG.md) for compatible versions.              |
+| Deployment Unit                                                | Version / Details                                                                              |
+|----------------------------------------------------------------|------------------------------------------------------------------------------------------------|
+| An Auth Proxy / Auth solution of your choice.                  | (deployment specific, required to secure UI and management API)                                |
+| Reverse Proxy that merges the UI+Backend and removes the ports | (deployment specific)                                                                          |
+| Postgresql                                                     | 13 or compatible version                                                                       |
+| EDC Backend                                                    | edc-ce or edc-ce-mds, see [CHANGELOG.md](../../../../../CHANGELOG.md) for compatible versions. |
+| EDC UI                                                         | edc-ui, see  [CHANGELOG.md](../../../../../CHANGELOG.md) for compatible versions.              |
 
 ## Configuration
 
@@ -88,7 +88,7 @@ A sovity EDC CE or MDS EDC CE Backend deployment requires:
 - The following configuration properties
 
 > [!WARNING]
-> Please be careful with overriding any of the ENV Vars set in our [launchers/.env](/launchers/.env). Our defaults
+> Please be careful with overriding any of the ENV Vars set in our [launchers/.env](../../../../../launchers/.env). Our defaults
 > will respect overrides, and the Core EDC ENV Vars can be in some cases sensitive to edge cases such as trailing
 > slashes.