Add html-proofer link check for 4.x docs

.github/workflows/jekyll.yaml

@@ -40,3 +40,5 @@ jobs:
       run: |
         ruby --version
         bundle exec jekyll build
+    - name: Check links
+      run: bundle exec rake links

Gemfile

@@ -2,3 +2,4 @@ ruby '>=3.2'
 source 'https://rubygems.org'
 gem 'jekyll', '>= 4.2.0'
 gem 'jekyll-redirect-from', '>= 0.16.0'
+gem 'html-proofer', '>= 5.2'

Gemfile.lock

@@ -1,25 +1,57 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    Ascii85 (2.0.1)
     addressable (2.8.8)
       public_suffix (>= 2.0.2, < 8.0)
+    afm (1.0.0)
+    async (2.37.0)
+      console (~> 1.29)
+      fiber-annotation
+      io-event (~> 1.11)
+      metrics (~> 0.12)
+      traces (~> 0.18)
     base64 (0.3.0)
+    benchmark (0.5.0)
     bigdecimal (4.0.1)
     colorator (1.1.0)
     concurrent-ruby (1.3.6)
+    console (1.34.3)
+      fiber-annotation
+      fiber-local (~> 1.1)
+      json
     csv (3.3.5)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
+    ethon (0.18.0)
+      ffi (>= 1.15.0)
+      logger
     eventmachine (1.2.7)
     ffi (1.17.3-x86_64-linux-gnu)
+    fiber-annotation (0.2.0)
+    fiber-local (1.1.0)
+      fiber-storage
+    fiber-storage (1.0.1)
     forwardable-extended (2.6.0)
     google-protobuf (4.33.5-x86_64-linux-gnu)
       bigdecimal
       rake (>= 13)
+    hashery (2.1.2)
+    html-proofer (5.2.2)
+      addressable (~> 2.3)
+      async (~> 2.1)
+      benchmark (~> 0.5)
+      nokogiri (~> 1.13)
+      pdf-reader (~> 2.11)
+      rainbow (~> 3.0)
+      typhoeus (~> 1.3)
+      yell (~> 2.0)
+      zeitwerk (~> 2.5)
     http_parser.rb (0.8.1)
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
+    io-event (1.11.2)
     jekyll (4.4.1)
       addressable (~> 2.4)
       base64 (~> 0.2)
@@ -57,9 +89,19 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
     mercenary (0.4.0)
+    metrics (0.15.0)
+    nokogiri (1.19.4-x86_64-linux-gnu)
+      racc (~> 1.4)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
+    pdf-reader (2.16.0)
+      Ascii85 (>= 1.0, < 3.0, != 2.0.0)
+      afm (>= 0.2.1, < 2)
+      hashery (~> 2.0)
+      ttfunk
     public_suffix (7.0.2)
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (13.3.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
@@ -71,18 +113,25 @@ GEM
       google-protobuf (~> 4.31)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
+    traces (0.18.2)
+    ttfunk (1.7.0)
+    typhoeus (1.6.0)
+      ethon (>= 0.18.0)
     unicode-display_width (2.6.0)
     webrick (1.9.2)
+    yell (2.2.2)
+    zeitwerk (2.8.3)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  html-proofer (>= 5.2)
   jekyll (>= 4.2.0)
   jekyll-redirect-from (>= 0.16.0)
 
 RUBY VERSION
   ruby 3.2.2
 
 BUNDLED WITH
-  4.0.6
+  4.0.21

README.md

@@ -109,6 +109,12 @@ HTML styled "just right".
 Jekyll will print a local URL where the site can be viewed (usually,
 [http://0.0.0.0:4000/](http://0.0.0.0:4000/)).
 
+To check internal links (also run in CI; scope is set in `Rakefile`):
+
+```bash
+bundle exec jekyll build && bundle exec rake links
+```
+
 ### Testing using a Container environment
 
 Note: The example commands below use `podman`, but you can replace it with a

Rakefile

@@ -0,0 +1,32 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+require 'html-proofer'
+
+# Internal link check; run `jekyll build` first
+task :links do
+  HTMLProofer.check_directory('./_site', {
+    disable_external: true,
+    check_internal_hash: true,
+    enforce_https: false,
+    allow_missing_href: true,
+    # only docs/4.x is checked for now
+    ignore_files: [%r{^\./_site/(?!docs/4\.x/)}, %r{/apidocs/}],
+  }).run
+end

_docs-4/administration/caching.md

@@ -18,7 +18,7 @@ for tables where read performance is critical.
 
 ## Configuration
 
-The {% plink tserver.cache.manager.class %} property controls which block cache implementation is used within the tablet server. Users
+The {% plink general.block.cache.manager.class %} property controls which block cache implementation is used within the tablet server. Users
 can supply their own implementation and set custom configuration properties to control its behavior (see org.apache.accumulo.core.spi.cache.BlockCacheManager$Configuration.java).
 
 The index and data block caches are configured for tables by the following properties: