From 4cb94a345a38c1f5cc5b32a09421780a54af5371 Mon Sep 17 00:00:00 2001 From: Ugo Pattacini Date: Thu, 14 Sep 2023 11:45:20 +0200 Subject: [PATCH] =?UTF-8?q?Fix=20external=20links=20=E2=80=93=20Stint=202?= =?UTF-8?q?=20(#315)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/check-links.yml | 8 +++++--- .../other-machines/icub-server-from-scratch.md | 2 +- .../icub_r1_calibration_types.md | 2 +- docs/robot_sensors/yarp_nws_convention.md | 2 +- docs/upgrade_kits/head_4k/support.md | 4 ++-- scripts/linkchecker/linkcheckerrc | 8 ++++++++ 6 files changed, 18 insertions(+), 8 deletions(-) create mode 100644 scripts/linkchecker/linkcheckerrc diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml index c263bd3e8..43d6b4b25 100644 --- a/.github/workflows/check-links.yml +++ b/.github/workflows/check-links.yml @@ -11,15 +11,17 @@ jobs: runs-on: ubuntu-latest steps: + - uses: actions/checkout@main - name: Dependencies run: | - pip install git+https://github.com/linkchecker/linkchecker.git + pip install --user git+https://github.com/linkchecker/linkchecker.git + echo "${HOME}/.local/bin" >> ${GITHUB_PATH} - name: Fetch repository name id: repo-name run: | - echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_OUTPUT + echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> ${GITHUB_OUTPUT} - name: Run checker run: | - linkchecker https://${{ github.repository_owner }}.github.io/${{ steps.repo-name.outputs.REPOSITORY_NAME }}/ --check-extern --no-warnings + linkchecker --config=./scripts/linkchecker/linkcheckerrc https://${{ github.repository_owner }}.github.io/${{ steps.repo-name.outputs.REPOSITORY_NAME }}/ diff --git a/docs/icub_operating_systems/other-machines/icub-server-from-scratch.md b/docs/icub_operating_systems/other-machines/icub-server-from-scratch.md index 9f5059a5e..5ae15d174 100644 --- a/docs/icub_operating_systems/other-machines/icub-server-from-scratch.md +++ b/docs/icub_operating_systems/other-machines/icub-server-from-scratch.md @@ -8,7 +8,7 @@ Latest version is based on Ubuntu Server 20.04.2 Please check that the BIOS configuration allows to boot from USB drive. ## Create the USB installer -The first step is download the [official Ubuntu 20.04 LTS Server install media](https://releases.ubuntu.com/focal/ubuntu-20.04.1-live-server-amd64.iso) from the [release page](https://releases.ubuntu.com/focal/) +The first step is to download the **official Ubuntu 20.04 LTS Server install media** from the [release page](https://releases.ubuntu.com/focal). Search for `ubuntu-20.04.x-live-server-amd64.iso`. Then please create the USB installer using an USB memory and a tool like [Balena Etcher](https://www.balena.io/etcher/). diff --git a/docs/icub_r1_icub3_calibration_types/icub_r1_calibration_types.md b/docs/icub_r1_icub3_calibration_types/icub_r1_calibration_types.md index 1b387ee6c..f817006de 100644 --- a/docs/icub_r1_icub3_calibration_types/icub_r1_calibration_types.md +++ b/docs/icub_r1_icub3_calibration_types/icub_r1_calibration_types.md @@ -32,7 +32,7 @@ For this reason, if the calibration needs a particular value of `calibrationZero ## The available calibrations in details --- -Here are described the usage of the various calibration types; the `param` are in the [calibrators files](https://github.com/robotology/robots-configuration/tree/master/iCubHongKong01/calibrators) where you'll find a file for each part of the robot and looks like : +Here are described the usage of the various calibration types; the `param` are in the [calibrators files](https://github.com/robotology/robots-configuration/tree/master/robots-icebox/iCubHongKong01/calibrators) where you'll find a file for each part of the robot and looks like : ```xml diff --git a/docs/robot_sensors/yarp_nws_convention.md b/docs/robot_sensors/yarp_nws_convention.md index 4a240cd1d..3f5db8c06 100644 --- a/docs/robot_sensors/yarp_nws_convention.md +++ b/docs/robot_sensors/yarp_nws_convention.md @@ -104,7 +104,7 @@ For each eye, there will be a `frameGrabber_nws_yarp` that will open the followi !!! warning - These YARP ports are not meant to be accessed directly, but should be accessed instead via the [`remote_framegrabber`](https://www.yarp.it/latest/classRemoteFrameGrabber.html) device. + These YARP ports are not meant to be accessed directly, but should be accessed instead via the `remote_framegrabber` device. The client device will expose the sensors thanks to the related [Media Interfaces](https://www.yarp.it/latest/group__dev__iface__media.html). diff --git a/docs/upgrade_kits/head_4k/support.md b/docs/upgrade_kits/head_4k/support.md index 29b673d39..9a91f7634 100644 --- a/docs/upgrade_kits/head_4k/support.md +++ b/docs/upgrade_kits/head_4k/support.md @@ -174,7 +174,7 @@ The NVIDIA Jetson has to be configured following [the flash procedure](../../icu If the image has been [installed from scratch](../../icub_operating_systems/icubos/jetpack.md#flash-a-new-image-from-scratch), an initial configuration is also required, which consists in: -- Set the `icub` as `host` and `icub-head-cam` as `hostname` -- [Configure the network bridge and wifi](https://github.com/icub-tech-iit/setups-os-configuration/blob/master/system-files/iCubOS/ubuntu_20.04_bridge/README.md) +- Set the `icub` as `host` and `icub-head-cam` as `hostname`. +- [Configure the network bridge and wifi](https://github.com/icub-tech-iit/setups-os-configuration/blob/master/system-files/iCubOS/ubuntu_20.04_bridge/README.md). For using the images provided by the new Basler camera over the YARP network, it is needed to compile and install [`yarp-device-pylon`](https://github.com/robotology/yarp-device-pylon#2-how-to-use-basler-pylon-cameras-as-a-yarp-device). diff --git a/scripts/linkchecker/linkcheckerrc b/scripts/linkchecker/linkcheckerrc new file mode 100644 index 000000000..0fac08ef1 --- /dev/null +++ b/scripts/linkchecker/linkcheckerrc @@ -0,0 +1,8 @@ +[checking] +sslverify=0 + +[output] +warnings=0 + +[filtering] +checkextern=1 \ No newline at end of file