Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix help.github.com link checks #3155

Merged
merged 2 commits into from
Apr 29, 2022
Merged

Fix help.github.com link checks #3155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e5d548
docs: Rename links_ignorelist.json to asciidoc-links-check-config.json
cfergeau Apr 29, 2022
1ac7b33
docs: Fix help.github.com link check
cfergeau Apr 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion images/docs-builder/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ RUN gem install asciidoctor && \

COPY entrypoint.sh /sbin/entrypoint.sh
RUN chmod 755 /sbin/entrypoint.sh
COPY links_ignorelist.json /links_ignorelist.json
COPY asciidoc-link-check-config.json /asciidoc-link-check-config.json

VOLUME /docs
WORKDIR /docs
Expand Down
9 changes: 8 additions & 1 deletion images/docs-builder/links_ignorelist.json → ...s-builder/asciidoc-link-check-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
{ "pattern": "^http://api.crc.testing" },
{ "pattern": "https://console-openshift-console.apps-crc.testing" },
{ "pattern": "http://proxy.example.com" }
],
"httpHeaders": [
{
"urls": ["https://help.github.com"],
"headers": {
"Accept-Encoding": "gzip, deflate"
}
}
]

}
2 changes: 1 addition & 1 deletion images/docs-builder/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ case $1 in
;;
docs_check_links)
echo "Checking if all links are alive in docs source"
find . -name \*.adoc | xargs -n1 asciidoc-link-check -c /links_ignorelist.json -q
find . -name \*.adoc | xargs -n1 asciidoc-link-check -c /asciidoc-link-check-config.json -q
;;
docs_serve)
cd build
Expand Down