From 75567bfd9fca98fa8fe4b53ef1b9f460fe583884 Mon Sep 17 00:00:00 2001 From: Frederic Mercier Date: Fri, 28 Jun 2024 09:18:37 +0200 Subject: [PATCH] Add markdown link check (#53) * DBACLD-139987 - Put in place checker link * ignore some broken links * ignore broken links with localhost URL --------- Co-authored-by: Frederic Mercier --- .github/workflows/check-links.yml | 25 +++++++++++++++++++++++++ .md_check_config.json | 14 ++++++++++++++ docker/dockerhub/full-description.md | 6 ++++-- topics/dssetup.md | 2 +- 4 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/check-links.yml create mode 100644 .md_check_config.json diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml new file mode 100644 index 0000000..2ea6949 --- /dev/null +++ b/.github/workflows/check-links.yml @@ -0,0 +1,25 @@ +name: Check Markdown links + +#on: +# push: +# branches: +# - master +# pull_request: +# branches: [master] +on: push +jobs: + markdown-link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: technote-space/get-diff-action@v6 + with: + PATTERNS: | + **/**.md + + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + use-quiet-mode: 'yes' + use-verbose-mode: 'yes' + config-file: '.md_check_config.json' + diff --git a/.md_check_config.json b/.md_check_config.json new file mode 100644 index 0000000..17934a0 --- /dev/null +++ b/.md_check_config.json @@ -0,0 +1,14 @@ +{ + "ignorePatterns": [ + { + "pattern": "^http://localhost" + } + ], + "replacementPatterns": [ + { + "pattern": "^/LICENSE", + "replacement": "{{BASEURL}}/LICENSE" + } + ], + "timeout": "20s" + } \ No newline at end of file diff --git a/docker/dockerhub/full-description.md b/docker/dockerhub/full-description.md index 0cc7481..1a71820 100644 --- a/docker/dockerhub/full-description.md +++ b/docker/dockerhub/full-description.md @@ -49,18 +49,20 @@ You must accept the license before you launch the image. The license is availabl docker run -e LICENSE=accept -p 8888:8888 -p 9999:9999 icr.io/cpopen/odm-k8s/odm-metering-service:9.0-amd64 ``` -When the server is started, use the URL http://localhost:8888 or https://localhost:9999 to display a welcome page. +When the server is started, use the URL http://localhost:8888 or https://localhost:9999 to display a welcome page. The metering service receives usage information from Operational Decision Manager and aggregates it. When the service is available, you can get a zip archive of the ILMT files by using the /backup REST API endpoint. -In a browser, access the zip archive by using http://localhost:8888/backup or https://localhost:9999/backup +In a browser, access the zip archive by using http://localhost:8888/backup or https://localhost:9999/backup or use the following curl command: + ```console curl http://localhost:8888/backup -o backup.zip curl -k https://localhost:9999/backup -o backup.zip ``` + ## Storage diff --git a/topics/dssetup.md b/topics/dssetup.md index 9398394..46c7225 100644 --- a/topics/dssetup.md +++ b/topics/dssetup.md @@ -15,7 +15,7 @@ Among the parameters listed in the res-setup task document, the following parame Parameter | Description :-: | :-: metering.api.key | This parameter is not used, but it is mandatory. Use an arbitrary value. -metering.server.url | To be set to the URL where the metering service is run, for example, http://host.company.com:8888/odm-metering-service. +metering.server.url | To be set to the URL where the metering service is run, for example, http://host.company.com:8888/odm-metering-service. metering.enable | To be set to true so that the metering components can run. metering.send.usages | To be set to true so that actual usages are sent to the metering service. metering.instance.identifier | If specified, it is used as a reference to identify a metering client instance within Operational Decision Manager. This information appears in the log of the metering service, so it is recommended to be customized.