Merge pull request eclipse-iceoryx#1297 from ApexAI/iox-#1294-markdow…

…n-link-verification-script

Iox eclipse-iceoryx#1294 markdown link verification script

.github/workflows/build-test.yml

@@ -16,6 +16,12 @@ jobs:
       - uses: actions/checkout@v2
       - run: ./tools/scripts/clang_format.sh check
 
+  verify-links-in-markdown-documentation:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - run: ./tools/ci/markdown-link-verificator.sh
+
   build-test-ubuntu:
     runs-on: ubuntu-20.04
     needs: pre-flight-check

CONTRIBUTING.md

@@ -58,7 +58,7 @@ Please make sure you have:
 7. You open your pull request towards the base branch `master`
 8. Link the pull request to the according GitHub issue and set the label accordingly
 
-**NOTE:** For support while developing you can use little helper scripts, see [git-hooks](https://github.com/eclipse-iceoryx/iceoryx/blob/master/tools/git-hooks/Readme.md).
+**NOTE:** For support while developing you can use little helper scripts, see [git-hooks](./tools/git-hooks/Readme.md).
 
 ## Branching strategy
 
@@ -105,7 +105,7 @@ codebase follows these rules, things are work in progress.
 2) **No exceptions are allowed**, all function and methods need to have `noexcept` in their signature
 3) **No undefined behavior**, zero-cost abstract is not feasible in high safety environments
 4) **Use C++14**
-5) **[Rule of Five](https://en.wikipedia.org/wiki/Rule_of_three_(C%2B%2B_programming))**, if there is a non-default
+5) **[Rule of Five](https://en.cppreference.com/w/cpp/language/rule_of_three)**, if there is a non-default
     destructor needed, the rule of five has to be applied
 6) **[STL](https://en.wikipedia.org/wiki/Standard_Template_Library)**, we aim to be compatible towards the STL, but
     our code may contain additions which are not compatible with the STL (e.g. `iox::cxx::vector::emplace_back()`
@@ -115,7 +115,7 @@ codebase follows these rules, things are work in progress.
     shall not be propagated via an `iox::cxx::expected`
 9) **Not more than two-level nested namespaces**, three-level nested namespace can be used sparsely
 
-See [error-handling.md](https://github.com/eclipse-iceoryx/iceoryx/blob/master/doc/design/error-handling.md) for additional
+See [error-handling.md](./doc/design/error-handling.md) for additional
 information about logging and error handling.
 
 ### Naming conventions
@@ -184,7 +184,7 @@ All new code should follow the folder structure.
 We use [Google test](https://github.com/google/googletest) for our unit and integration tests. We require compatibility
 with the version 1.10.0.
 
-Have a look at our [best practice guidelines](./doc/website/advanced/best-practice-for-testing.md) for writing tests and
+Have a look at our [best practice guidelines](./doc/website/concepts/best-practice-for-testing.md) for writing tests and
 [installation guide for contributors](./doc/website/advanced/installation-guide-for-contributors.md#build-and-run-tests) for building them.
 
 ### Unit tests (aka module tests)
@@ -289,14 +289,11 @@ Or with a comment one line above (the number after the warning number indicates
 *mynullptr = foo;
 ```
 
-Scan results of the `master` branch are available on a [Axivion dashboard](https://iceoryx-axivion.apex.ai/). Please
+Scan results of the `master` branch are available on a [Axivion dashboard](https://iceoryx-axivion.apex.ai/)<!--NOLINT see issue: #1298-->. Please
 contact one of the maintainers, if you're interested in getting access.
 
 Don't be afraid if you don't have Axivion available. As we want to make it easy for developers to contribute,
-please raise a pull request and one of the maintainers will provided you access to the [dashboard](https://iceoryx-axivion.apex.ai/).
-
-As an alternative it is also possible to use Perforce's
-[Helix QAC++](https://www.perforce.com/products/helix-qac) to perform a static-code analysis.
+please raise a pull request and one of the maintainers will provided you access to the [dashboard](https://iceoryx-axivion.apex.ai/)<!--NOLINT see issue: #1298-->.
 
 ### Header
 

QUALITY_DECLARATION.md

@@ -6,7 +6,7 @@ The packages `iceoryx_hoofs`, `iceoryx_posh` and `iceoryx_binding_c` claim to be
 
 Below are the rationales, notes, and caveats for this claim, organized by each requirement listed in the [Package Requirements for Quality Level 2 in REP-2004](https://www.ros.org/reps/rep-2004.html).
 
-See the [Readme](https://github.com/eclipse-iceoryx/iceoryx#quality-levels--platforms) for a full list of the quality levels of iceoryx components and [Contributing Guide](https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md#quality-levels) for a description of the quality levels.
+See the [Readme](README.md#quality-levels--platforms) for a full list of the quality levels of iceoryx components and [Contributing Guide](./CONTRIBUTING.md#quality-levels) for a description of the quality levels.
 
 ## Version Policy [1]
 
@@ -17,13 +17,13 @@ Changes for MINOR releases are API compatible and ideally ABI stable if not clea
 
 A similar format is prescribed by the Eclipse Foundation in the [Release Handbook](https://www.eclipse.org/projects/handbook/#release).
 
-On Git, the tags have a `v` prefix before the version numbers. A [release script](https://github.com/eclipse-iceoryx/iceoryx/blob/master/tools/scripts/iceoryx_release.sh) shall ensure that version numbers are kept consistent for all packages.
+On Git, the tags have a `v` prefix before the version numbers. A [release script](./tools/scripts/iceoryx_release.sh) shall ensure that version numbers are kept consistent for all packages.
 
 ### Version Stability [1.ii]
 
 Since release `1.0.0` iceoryx is at a stable version, i.e. `>= 1.0.0`. The latest valid release can be found on the [release page](https://github.com/eclipse-iceoryx/iceoryx/releases) of iceoryx.
 
-The change history can be found in the [release notes section](https://iceoryx.io/latest/release-notes).
+The change history can be found in the [release notes section](./doc/website/release-notes).
 
 ### Public API Declaration [1.iii]
 
@@ -55,8 +55,8 @@ It is planned to build and test the changes on the ROS CI for early detection of
 
 ### Change Requests [2.i]
 
-All changes in the codebase require a Pull-Request. It is mandatory to link the Pull-Request to a corresponding [issue ticket](https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md#feature-request-and-bugs) on GitHub to ensure traceability.
-The contributor and reviewer are required to fill out a [Pull-Request Template](https://github.com/eclipse-iceoryx/iceoryx/blob/master/.github/PULL_REQUEST_TEMPLATE.md) before merging.
+All changes in the codebase require a Pull-Request. It is mandatory to link the Pull-Request to a corresponding [issue ticket](./CONTRIBUTING.md#feature-request-and-bugs) on GitHub to ensure traceability.
+The contributor and reviewer are required to fill out a [Pull-Request Template](./.github/PULL_REQUEST_TEMPLATE.md) before merging.
 
 ### Contributor Origin [2.ii]
 
@@ -89,49 +89,49 @@ It is required to create/modify the Doxygen/design and user documentation within
 
 ### Feature Documentation [3.i]
 
-The documentation of the main iceoryx features (sending, receiving data) can be found in the [overview](https://iceoryx.io/latest/getting-started/overview/) and [iceoryx examples](https://iceoryx.io/latest/getting-started/examples/) including a user-friendly description on how to use the iceoryx API.
-The [configuration guide](https://iceoryx.io/latest/advanced/configuration-guide/) completes the documentation on how to use iceoryx.
+The documentation of the main iceoryx features (sending, receiving data) can be found in the [overview](./doc/website/getting-started/overview.md) and [iceoryx examples](./iceoryx_examples) including a user-friendly description on how to use the iceoryx API.
+The [configuration guide](./doc/website/advanced/configuration-guide.md) completes the documentation on how to use iceoryx.
 
-Detailed technical documentation about iceoryx features can be found in the [design document](https://github.com/eclipse-iceoryx/iceoryx/tree/master/doc/design) section with descriptions and diagrams about internal mechanisms of iceoryx.
+Detailed technical documentation about iceoryx features can be found in the [design document](./doc/design) section with descriptions and diagrams about internal mechanisms of iceoryx.
 
-For new features, it is recommended to first create a design document, see the [Contribution Guidelines](https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md#feature-request-and-bugs) for more information.
-Diagrams in feature descriptions need to be consistently generated with [PlantUML](https://github.com/eclipse-iceoryx/iceoryx/tree/master/doc/design#design-documents).
+For new features, it is recommended to first create a design document, see the [Contribution Guidelines](./CONTRIBUTING.md#feature-request-and-bugs) for more information.
+Diagrams in feature descriptions need to be consistently generated with [PlantUML](./doc/design/README.md#add-diagrams-using-plantuml).
 
 Currently there is ongoing work to complete the documentation of existing features to reach quality level 1.
 
 ### Public API Documentation [3.ii]
 
-The public API is documented in form of Doxygen comments and available as API reference on [iceoryx.io](https://iceoryx.io/).
+The public API is documented in form of Doxygen comments and available as API reference on [iceoryx.io](https://iceoryx.io/). <!--NOLINT explicit link to website-->
 
 ### License [3.iii]
 
 The license for Eclipse iceoryx is the Apache License 2.0, and each code file includes a license statement.
-The full license text is available in the [`LICENSE`](https://github.com/eclipse-iceoryx/iceoryx/blob/master/LICENSE) file.
-The project includes a [`NOTICE`](https://github.com/eclipse-iceoryx/iceoryx/blob/master/NOTICE.md) with links to more information about these licenses.
+The full license text is available in the [`LICENSE`](./LICENSE) file.
+The project includes a [`NOTICE`](./NOTICE.md) with links to more information about these licenses.
 
 There is some third-party content included with Eclipse iceoryx which is licensed as MIT or New BSD.
-Details can also be found in the included [`NOTICE`](https://github.com/eclipse-iceoryx/iceoryx/blob/master/NOTICE.md#third-party-dependencies) document.
+Details can also be found in the included [`NOTICE`](./NOTICE.md#third-party-dependencies) document.
 
 ### Copyright Statement [3.iv]
 
-Each source code file in Eclipse iceoryx has a copyright header that needs to follow this [style](https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md#header).
+Each source code file in Eclipse iceoryx has a copyright header that needs to follow this [style](./CONTRIBUTING.md#header).
 
 A CI job ensures by checking with `ament_copyright` that all files comply with this rule.
 
 ## Testing [4]
 
-Every iceoryx package has a `test` folder that contains subfolders for [module- and/or integrationtests](https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md#testing) written based on the Google test framework. All tests are running on the CI for every Pull-Request for all supported platforms and are contained in the master branch.
+Every iceoryx package has a `test` folder that contains subfolders for [module- and/or integrationtests](./CONTRIBUTING.md#testing) written based on the Google test framework. All tests are running on the CI for every Pull-Request for all supported platforms and are contained in the master branch.
 Currently, due to limited support on Windows, there are some exclusions for testing on the CI.
 
 ### Feature Testing [4.i]
 
-The features of iceoryx are tested in the [iceoryx_integrationtest](https://github.com/eclipse-iceoryx/iceoryx/tree/master/iceoryx_integrationtest) package. Using `launch_test`, tests are executed on system-level to ensure that the iceoryx packages are functional and the Public API works according to specification.
+The features of iceoryx are tested in the [iceoryx_integrationtest](./iceoryx_integrationtest) package. Using `launch_test`, tests are executed on system-level to ensure that the iceoryx packages are functional and the Public API works according to specification.
 There is continuous effort to cover the corner cases in the usage of iceoryx in test-cases.
 
 ### Public API Testing [4.ii]
 
 All tests are executed for every major feature. New features must provide unit and integration tests that cover the code changes in the Pull-Request. The tests reside in separated folders for every package following a defined structure and naming convention.
-The features are tested at module(unit) -integration and system test level. The [guidelines](https://iceoryx.io/latest/advanced/best-practice-for-testing/) for Contributors ensure a high quality of test development.
+The features are tested at module(unit) -integration and system test level. The [guidelines](./doc/website/concepts/best-practice-for-testing.md) for Contributors ensure a high quality of test development.
 
 ### Coverage [4.iii]
 
@@ -142,14 +142,14 @@ The Eclipse iceoryx project use [gcov](https://gcc.gnu.org/onlinedocs/gcc/Gcov.h
 - Branch Coverage
 
 The coverage results of every Pull-Request and master branch are publicly available on [codecov.io](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx).
-A detailed report (e.g. the coverage in different packages) can be obtained by following [this](https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md#coverage-scan) guide.
+A detailed report (e.g. the coverage in different packages) can be obtained by following [this](./CONTRIBUTING.md#coverage-scan) guide.
 
 ### Performance [4.iv]
 
 The most important measurement units for performance testing on iceoryx are the data transfer latency and the CPU load incurred by passing data.
 They can be obtained in two ways:
 
-1. [iceperf](https://github.com/eclipse-iceoryx/iceoryx/tree/master/iceoryx_examples/iceperf#iceperf)
+1. [iceperf](./iceoryx_examples/iceperf/README.md)
 This performance test uses the iceoryx API directly without any indirections to compare different IPC mechanisms on increasing payload sizes.
 The output is a table showing various payload sizes with their corresponding latency in microseconds.
 
@@ -162,10 +162,10 @@ Currently, there are no automatic regression tests in the CI running. The work t
 
 ### Linters and Static Analysis [4.v]
 
-The code formatting is enforced through the CI using `clang-format` and can be used by following this [guide](https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md#coding-style)
+The code formatting is enforced through the CI using `clang-format` and can be used by following this [guide](./CONTRIBUTING.md#coding-style)
 
 The codebase is checked with `clang-tidy` to enforce naming conventions and basic coding rules and checked in the Pull-Requests by review.
-A [static code analysis](https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md#static-code-analysis) is done regularly with the Axivion Suite, but the results are not publicly accessible due to licensing.
+A [static code analysis](./CONTRIBUTING.md#static-code-analysis) is done regularly with the Axivion Suite, but the results are not publicly accessible due to licensing.
 
 ## Dependencies [5]
 
@@ -194,4 +194,4 @@ Every release that is integrated with ROS will be build with the ROS CI to ensur
 This package conforms to the Vulnerability Disclosure Policy in REP-2006.
 The Eclipse Project Handbook states the project's [vulnerability disclosure policy](https://www.eclipse.org/projects/handbook/#vulnerability-disclosure) in detail.
 
-The [iceoryx website](https://iceoryx.io) provides a link to report a security vulnerability.
+The [iceoryx website](https://iceoryx.io)<!--NOLINT explicit link to website--> provides a link to report a security vulnerability.

README.md

@@ -45,7 +45,7 @@ instead the typed C++ API. The normal use case is that iceoryx is integrated as
 a bigger framework with additional API layers.
 An example for such a "porcelain" API would be [ROS 2](https://www.ros.org/). Others are listed in the next section.
 
-You can find the full API documentation on 🌐 [https://iceoryx.io](https://iceoryx.io).
+You can find the full API documentation on 🌐 [https://iceoryx.io](https://iceoryx.io). <!--NOLINT explicit link to website-->
 
 ### Supported Platforms
 
@@ -66,7 +66,7 @@ In general unix platforms should work with iceoryx but we only test FreeBSD on o
 | [ROS 2](https://github.com/ros2/rmw_iceoryx) | Eclipse iceoryx can be used inside the [Robot Operating System](https://www.ros.org/) with [rmw_iceoryx](https://github.com/ros2/rmw_iceoryx.git) |
 | [eCAL](https://github.com/continental/ecal) | Open-source framework from [Continental AG](https://www.continental.com/) supporting pub/sub and various message protocols |
 | [RTA-VRTE](https://www.etas.com/en/products/rta-vrte.php) | [AUTOSAR Adaptive Platform](https://www.autosar.org/standards/adaptive-platform/) software framework for vehicle computer from [ETAS GmbH](https://www.etas.com) |
-| [Cyclone DDS](https://github.com/eclipse-cyclonedds/cyclonedds) | Performant and robust open-source DDS implementation maintained by [ADLINK Technology Inc.](https://www.adlinktech.com/) |
+| [Cyclone DDS](https://github.com/eclipse-cyclonedds/cyclonedds) | Performant and robust open-source DDS implementation maintained by [ADLINK Technology Inc.](https://www.adlinktech.com/en/index.aspx) | <!--NOLINT ADlink seems to be sporadically unreachable-->
 | [Apex.Middleware](https://www.apex.ai/apex-middleware) | Safe and certified middleware for autonomous mobility systems from [Apex.AI](https://www.apex.ai/) |
 | [AVIN AP](https://www.avinsystems.com/products/autosar_ap_solutions/) | AUTOSAR Adaptive Platform Product from AVIN Systems |
 

doc/aspice_swe3_4/swe_docu_guidelines.md

@@ -93,7 +93,7 @@ Generally, you will not find any Doxygen file in our repo because we let CMake g
 In [Cmake](CMakeLists.txt) is the command `doxygen_add_docs` which does the job.
 There, we are also setting some parameters and the aliases for the custom tags. Aliases with an `xrefitem` create a page where all occurrences of the corresponding tag are collected.
 ### file header
-Please see [Header](https://github.com/eclipse-iceoryx/iceoryx/blob/master/CONTRIBUTING.md#header).
+Please see [Header](../../CONTRIBUTING.md#header).
 
 ### Include guards
 Every header and inl file needs to have an include guard. Pragma once is not allowed.

doc/design/README.md

@@ -19,7 +19,7 @@ A good online-editor with cheat-sheet can be found at [https://plantuml-editor.k
 Alternatively you can use extensions in your IDE.
 
 The integration of the generated PlantUML into your design documents is done via *.svg files.
-You need to create a .puml file and export it to .svg afterwards for linking it with the markdown. In the `tools` folder is a [helper script](https://github.com/eclipse-iceoryx/iceoryx/blob/master/tools/scripts/generate_plantuml_svg.sh) provided which downloads a defined version of PlantUML to export the vector graphics.
+You need to create a .puml file and export it to .svg afterwards for linking it with the markdown. In the `tools` folder is a [helper script](../../tools/scripts/generate_plantuml_svg.sh) provided which downloads a defined version of PlantUML to export the vector graphics.
 These steps are necessary due to the current support of PlantUML in [Github](https://github.community/t/support-uml-diagrams-in-markdown-with-plantuml-syntax/626).
 
 **NOTE:** Don't set parameter for theming (like background color) directly in individual puml files but use the central `doc/iceoryx-plantuml-config.puml` which is shared with all diagrams.

doc/design/draft/service-discovery.md

@@ -74,9 +74,9 @@ Create a new publisher in RouDi which sends a `ServiceRegistryTopic`. This publi
 change in the service registry and to transmit the service discovery registry. The complete old service registry
 (saved locally) would be compared to the new service registry in a new class, extending the public user API.
 
-![overview diagram](../website/images/overview-alternative-d.svg)
+![overview diagram](../../website/images/overview-alternative-d.svg)
 
-![sequence diagram](../website/images/sequence-diagram-alternative-d.svg)
+![sequence diagram](../../website/images/sequence-diagram-alternative-d.svg)
 
 Pro: