Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

SOLR-15267: fix jekyll layouts and CheckLinksAndAnchors to ensure link checking is applied to every page regardless of layout

Chris Hostetter81e1e4387d52
diff --git a/solr/solr-ref-guide/src/_layouts/home.html b/solr/solr-ref-guide/src/_layouts/home.html
index c1d9cb60a10..be1b40137a1 100644
--- a/solr/solr-ref-guide/src/_layouts/home.html
+++ b/solr/solr-ref-guide/src/_layouts/home.html
@@ -10,7 +10,11 @@ layout: default
{% comment %}NOTE: page_id is also defined in default.html{% endcomment %}
{% assign page_id = page.url | split: '/' | last | remove: '.html' %}
-<div class="homepage container">
+{% comment %}
+NOTE: link-check-root is not used in any CSS, but must exist once per page as a wrapper
+ around all content that should have links checked (ie: we don't link check header/footer)
+{% endcomment %}
+<div class="homepage container link-check-root">
{{ content }}
</div>
diff --git a/solr/solr-ref-guide/src/_layouts/page.html b/solr/solr-ref-guide/src/_layouts/page.html
index 394d3e028df..2d11f2d0912 100755
--- a/solr/solr-ref-guide/src/_layouts/page.html
+++ b/solr/solr-ref-guide/src/_layouts/page.html
@@ -18,7 +18,11 @@ layout: default
</nav>
{% endif %}
- <section class="content">
+ {% comment %}
+ NOTE: link-check-root is not used in any CSS, but must exist once per page as a wrapper
+ around all content that should have links checked (ie: we don't link check header/footer)
+ {% endcomment %}
+ <section class="content link-check-root">
{{ content }}
</section>
diff --git a/solr/solr-ref-guide/tools/CheckLinksAndAnchors.java b/solr/solr-ref-guide/tools/CheckLinksAndAnchors.java
index 285e5f95e7e..1ef447c7a2d 100644
--- a/solr/solr-ref-guide/tools/CheckLinksAndAnchors.java
+++ b/solr/solr-ref-guide/tools/CheckLinksAndAnchors.java
@@ -168,11 +168,12 @@ public class CheckLinksAndAnchors { // TODO: rename this class now that it does
// For Jekyll, we only care about class='content' -- we don't want to worry
// about ids/links duplicated in the header/footer of every page,
- final String mainContentSelector = bareBones ? "body" : ".content";
- final Element mainContent = doc.select(mainContentSelector).first();
- if (mainContent == null) {
- throw new RuntimeException(file.getName() + " has no main content: " + mainContentSelector);
- }
+ final String mainContentSelector = bareBones ? "body" : ".link-check-root";
+ final Elements mainContents = doc.select(mainContentSelector);
+ if (1 != mainContents.size()) {
+ throw new RuntimeException(file.getName() + " has " + mainContents.size() + " main content elements: " + mainContentSelector);
+ }
+ final Element mainContent = mainContents.first();
// All of the ID (nodes) in (the content of) this doc
final Elements nodesWithIds = mainContent.select("[id]");