Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 0 additions & 23 deletions .github/workflows/build-and-validate-on-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,6 @@ jobs:
with:
fetch-depth: 0 # Necessary for git diff in vale step

# Cache for Antora UI and Htmltest.
# See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows
# Htmltest accepts 2 weeks old cache for the status code of checked external URLs
# See: https://github.com/wjdp/htmltest
# Refresh the cache every week to avoid a stale cache for htmltest
# See: https://github.com/actions/cache
# See: http://man7.org/linux/man-pages/man1/date.1.html
- name: Get Date
id: get-date
run: echo "YEAR_WEEK=$(/bin/date -u +%Y%U)" >> $GITHUB_OUTPUT
shell: bash

- name: Restore cache
uses: actions/cache@v3
env:
cache-name: cache
with:
path: .cache
key: ${{ steps.get-date.outputs.YEAR_WEEK }}

- name: Build using antora # and fail on warning
id: antora-build
run: CI=true antora generate antora-playbook-for-development.yml --stacktrace --log-failure-level=warn
Expand All @@ -62,9 +42,6 @@ jobs:
PR_NUMBER
PR_SHA

- name: Validate links using htmltest
id: validate-links
run: htmltest

- name: Report unused content
run: tools/detect-unused-content.sh
Expand Down
26 changes: 0 additions & 26 deletions .github/workflows/build-and-validate-on-push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@
# SPDX-License-Identifier: EPL-2.0
#

# GitHub Actions configuration file for htmltest
# See: https://github.com/wjdp/htmltest

name: Build and validate
on:
push:
Expand All @@ -26,25 +23,6 @@ jobs:
with:
fetch-depth: 0

# Cache for Antora UI and Htmltest.
# See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows
# Htmltest accepts 2 weeks old cache for the status code of checked external URLs
# See: https://github.com/wjdp/htmltest
# Refresh the cache every week to avoid a stale cache for htmltest
# See: https://github.com/actions/cache
# See: http://man7.org/linux/man-pages/man1/date.1.html
- name: Get Date
id: get-date
run: echo "YEAR_WEEK=$(/bin/date -u +%Y%U)" >> $GITHUB_OUTPUT
shell: bash
- name: Restore cache
uses: actions/cache@v3
env:
cache-name: cache
with:
path: .cache
key: ${{ steps.get-date.outputs.YEAR_WEEK }}

- name: Build using antora
id: antora-build
run: CI=true antora generate antora-playbook-for-development.yml --stacktrace --log-failure-level=warn
Expand All @@ -55,10 +33,6 @@ jobs:
name: doc-content
path: build/site

- name: Validate links using htmltest
id: validate-links
run: htmltest

- name: Report unused content
run: tools/detect-unused-content.sh

Expand Down
37 changes: 0 additions & 37 deletions .htmltest.yml

This file was deleted.

2 changes: 0 additions & 2 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ To understand the nature of topics, see the link:https://redhat-documentation.gi

** link:https://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc] is the markup language.

** link:https://github.com/wjdp/htmltest[htmltest] validates the links.

** link:https://docs.errata.ai/vale/about/[Vale] validates the language.

** link:https://www.shellcheck.net/[ShellCheck] validates the shell scripts.
Expand Down
2 changes: 0 additions & 2 deletions Containerfile
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ RUN set -x \
git-core \
graphviz \
grep \
htmltest \
jq \
nodejs \
python3-pip \
Expand Down Expand Up @@ -109,7 +108,6 @@ RUN set -x \
&& curl --version \
&& git --version \
&& gulp --version \
&& htmltest --version \
&& jq --version \
&& pip3 freeze \
&& vale --version \
Expand Down
2 changes: 0 additions & 2 deletions antora-playbook-for-development.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# Use this Antora Playbook for development, to build current state in HEAD.
site:
title: Eclipse Che Documentation
# Disabling url on purpose to avoid htmltest crawling the live website.
# url: https://www.eclipse.org/che/docs
start_page: docs:overview:introduction-to-eclipse-che.adoc
robots: allow
Expand All @@ -19,7 +18,6 @@ antora:
index_latest_only: true
snippet_length: 142
- require: '@antora/collector-extension' # Single-source content from engineering repositories, see https://gitlab.com/antora/antora-collector-extension
- require: ./extensions/htmltest.js # Test links in HTML, see https://docs.antora.org/antora/latest/extend/extension-tutorial/
- require: '@antora/pdf-extension' # Generate monolithic AsciiDoc files, see https://gitlab.com/antora/antora-assembler

asciidoc:
Expand Down
1 change: 0 additions & 1 deletion code_review_checklist.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ These automated steps block the pull request merge.

* [ ] *`Build and validate PR / link checker (pull_request)`* is successful
** [ ] *`Build using Antora`* step is successful: documentation is building without warnings, and all AsciiDoc attributes have a definition.
** [ ] *`Validate links using htmltest`* step is successful: internal and external links are valid.
** [ ] *`Validate language on files added or modified`* step is successful and reports no vale errors: basic language validation, no major deviations from link:https://www.oreilly.com/library/view/the-ibm-style/9780132118989/[IBM Style Guide] and link:https://redhat-documentation.github.io/supplementary-style-guide/[Supplementary Style Guide], and project specific language rules.
* [ ] *`eclipsefdn/eca`* is successful: all contributors have signed the Eclipse Contributor Agreement (ECA).

Expand Down
21 changes: 0 additions & 21 deletions extensions/htmltest.js

This file was deleted.

1 change: 0 additions & 1 deletion tools/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@
set -ex
umask 002
CI=true antora generate antora-playbook-for-development.yml --stacktrace --log-failure-level=warn
htmltest
Loading