Comments (7)
Nevermind all that!
After six hours of yesterday's work, I learned that linkchecker does work if you specify it in the make like this: make linkchecker BUILD=satellite
. HOWEVER, it is strange that it does not seem to detect all the links. make linkechecker BUILD=satellite
on 3.1 branch in doc-Upgrading_and_Updating checks 29 URLs, while a grep search for different URLs returns 38, so my work may not be completely in vain 😅. Attaching output.
from foreman-documentation.
This is configured via the ignore option in linkchecker.ini:
foreman-documentation/guides/common/linkchecker.ini
Lines 7 to 23 in eb0b825
As you can see, it ignores 6.11. In feb42e7 I turned it on for 3.1.
#1750 is an effort to properly resolve it for master. You're (very) welcome to take over the effort.
from foreman-documentation.
Still, not all the links are checked for the 3.1 branch as can be seen from the output above. Nevertheless I can take over #1750 if you wish, but the work will probably be postponed because I will be less active in the coming days.
from foreman-documentation.
I'd recommend running linkchecker
with --verbose
and compare URLs.
from foreman-documentation.
I tested this on 3.1 for the Upgrading guide. Here are the commands that I used and the output:
$ make BUILD=satellite
$ linkchecker --verbose ../build/Upgrading_and_Updating/index-satellite.html | grep 'Real URL' | tr -s ' ' | cut -d' ' -f3 | sort > linkchecker-checked-urls.txt
$ grep -oE 'href="http[^"]+' ../build/Upgrading_and_Updating/index-satellite.html | sed -e 's/href="//' | sort | uniq > grepped-urls.txt
$ diff linkchecker-checked-urls.txt grepped-urls.txt
1,3d0
< file:///home/alazik/repos/foreman-documentation/guides/build/Upgrading_and_Updating/index-satellite.html
< file:///js/nav.js
< file:///js/versions.js
11c8,9
< https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html/release_notes/index
---
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html/release_notes/index#
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html/release_notes/index#ref_known-issues_assembly_introducing-red-hat-satellite
12a11,14
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Performing_an_Incremental_Backup_admin
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Renaming_Server_admin
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Restoring_from_a_Full_Backup_admin
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/administering_red_hat_satellite/index#Restoring_from_Incremental_Backups_admin
13a16,17
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_capsule_server/index#
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_capsule_server/index#deploying-a-custom-ssl-certificate-to-capsule-server_capsule
14a19,20
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_connected_network_environment/index#
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_connected_network_environment/index#configuring-external-services
15a22,25
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_disconnected_network_environment/index#
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_disconnected_network_environment/index#configuring-the-base-operating-system-with-offline-repositories-in-rhel-7_satellite
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_disconnected_network_environment/index#configuring-the-base-operating-system-with-offline-repositories-in-rhel-8_satellite
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_disconnected_network_environment/index#downloading-the-binary-dvd-images_satellite
16a27
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/installing_satellite_server_in_a_disconnected_network_environment/index#resolving-package-dependency-errors_satellite
17a29
> https://access.redhat.com/documentation/en-us/red_hat_satellite/6.11/html-single/managing_hosts/index#Configuring_and_Setting_Up_Remote_Jobs_managing-hosts
According to this, there are quite a few URLs that didn't get checked by the linkchecker.
Attaching the two output files.
grepped-urls.txt
linkchecker-checked-urls.txt
from foreman-documentation.
If I strip off the #ref
(which the server doesn't care about) it looks like there is no difference:
$ diff -Nut <(linkchecker --verbose ../build/Upgrading_and_Updating/index-satellite.html | grep 'Real URL' | tr -s ' ' | cut -d' ' -f3 | sed 's/#.*//' | sort) <(grep -oE 'href="http[^"]+' ../build/Upgrading_and_Updating/index-satellite.html | sed -e 's/href="// ; s/#.*//' | sort -u)
INFO linkcheck.cmdline 2022-12-01 14:02:49,057 MainThread Checking intern URLs only; use --check-extern to check extern URLs.
--- /dev/fd/63 2022-12-01 14:02:48.886036197 +0100
+++ /dev/fd/62 2022-12-01 14:02:48.887036210 +0100
@@ -1,6 +1,3 @@
-file:///home/ekohl/dev/foreman-documentation/3.1/guides/build/Upgrading_and_Updating/index-satellite.html
-file:///js/nav.js
-file:///js/versions.js
https://access.redhat.com/articles/3664871
https://access.redhat.com/articles/4977891
https://access.redhat.com/articles/6393361
Can we close this?
from foreman-documentation.
Sure. I realized later that link-check does not solve that problem either.
from foreman-documentation.
Related Issues (20)
- Unsure if we should use "provider_type" in some way. See `rg "provider_type:"` in foreman_remote_execution.
- Extend lists of supported OSs for upstream too HOT 1
- Clarify terminology: SmartProxy/SmartProxyServer, Internal/External/Isolated HOT 3
- Check and (if necessary) update supported versions for upstream and downstreams
- Overview docs are missing a chapter on config management HOT 1
- Overview docs are missing information about the REX pull mode under remote execution
- Add warning about EPEL not being supported in the repo setup section of install/update guides
- Planning for {Project} Guide - Content Sources terminology
- should we drop 'Content hosts'? HOT 3
- friendly reminder: do not forget to cherry-pick to 3.10! HOT 3
- Reword "internal Smart Proxy" and "external Smart Proxy" HOT 1
- Restructure branches into web and guides (nightly, X.Y, etc) HOT 4
- Decide on foreman-installer "--option=true" vs --option true" HOT 4
- Re-document katello-pull-transport-migrate
- Check if "Content Host" needs to be removed from Prereqs too HOT 7
- Add hint about default Puppet Environment HOT 2
- Fix version details - RHEL7 to RHEL8 on Satellite v6.12 - v6.15 in performance tuning doc HOT 1
- Removal of {context} from IDs HOT 1
- Make long headers easier to read HOT 6
- Introduce a Foreman & DNS guide HOT 9
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from foreman-documentation.