From 364ddc6125900095979bb43a40ed7e0b21dc7184 Mon Sep 17 00:00:00 2001
From: Aidan Reilly <74046732+aireilly@users.noreply.github.com>
Date: Thu, 17 Oct 2024 12:51:13 +0100
Subject: [PATCH] Don't lint commented lines

---
 .github/workflows/vale-on-pull.yml                          | 4 +++-
 .../OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc        | 2 ++
 .../OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc   | 2 ++
 .../OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc       | 4 ++--
 .vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml          | 2 +-
 .vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml     | 2 +-
 .vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml         | 2 +-
 antora-playbook.yml                                         | 1 -
 modules/contributor-guide/nav.adoc                          | 3 +--
 modules/contributor-guide/pages/.placeholder                | 0
 modules/contributor-guide/pages/contributor-guide.adoc      | 6 ------
 modules/contributor-guide/partials/nav.adoc                 | 1 -
 modules/reference-guide/nav.adoc                            | 3 +--
 modules/reference-guide/pages/reference-guide.adoc          | 6 ------
 modules/reference-guide/partials/nav.adoc                   | 1 -
 modules/user-guide/nav.adoc                                 | 3 +--
 modules/user-guide/pages/.placeholder                       | 0
 modules/user-guide/pages/user-guide.adoc                    | 6 ------
 modules/user-guide/pages/using-vale-in-the-ide.adoc         | 2 +-
 modules/user-guide/partials/nav.adoc                        | 1 -
 20 files changed, 16 insertions(+), 35 deletions(-)
 delete mode 100644 modules/contributor-guide/pages/.placeholder
 delete mode 100644 modules/contributor-guide/pages/contributor-guide.adoc
 delete mode 120000 modules/contributor-guide/partials/nav.adoc
 delete mode 100644 modules/reference-guide/pages/reference-guide.adoc
 delete mode 120000 modules/reference-guide/partials/nav.adoc
 delete mode 100644 modules/user-guide/pages/.placeholder
 delete mode 100644 modules/user-guide/pages/user-guide.adoc
 delete mode 120000 modules/user-guide/partials/nav.adoc

diff --git a/.github/workflows/vale-on-pull.yml b/.github/workflows/vale-on-pull.yml
index ab3d763b1..f17b38a71 100644
--- a/.github/workflows/vale-on-pull.yml
+++ b/.github/workflows/vale-on-pull.yml
@@ -13,9 +13,11 @@ on: [pull_request]
 jobs:
   vale:
     name: Linting with Vale
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
+      - name: Install Asciidoctor
+        run: sudo apt-get install -y asciidoctor
       - uses: errata-ai/vale-action@reviewdog
         with:
           filter_mode: diff_context
diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc
index 2a4fb8c21..6d5015657 100644
--- a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc
+++ b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc
@@ -1 +1,3 @@
 No xrefs here!
+
+//xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Getting started with {product-title}]
diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc
index b128ebbb8..8482919bd 100644
--- a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc
+++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc
@@ -1,3 +1,5 @@
 xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}]
 
 xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started
+
+// stuff xref:../rosa/rosa-getting-started.adoc[Getting started with {product-title}]
diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc
index 3453e7677..ec01802bf 100644
--- a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc
+++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc
@@ -1,6 +1,6 @@
+//vale-fixture
 xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}]
 
-xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started
-
+//xref:../rosa_getting_started/rosa-getting-started.html#getting-started[Getting started with {product-title}]
 
 
diff --git a/.vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml b/.vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml
index 9de1831cf..5822240df 100644
--- a/.vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml
+++ b/.vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml
@@ -5,4 +5,4 @@ level: error
 link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#links-hyperlinks-and-cross-references
 message: "Do not include xrefs in modules, only assemblies."
 tokens:
-  - 'xref:(.*)(\.adoc)#(.*)'
+  - '(?<!\/\/.*)xref:(.*)(\.adoc)#(.*)'
diff --git a/.vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml b/.vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml
index d465d3de3..90cf1c33e 100644
--- a/.vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml
+++ b/.vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml
@@ -5,4 +5,4 @@ level: error
 link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#links-hyperlinks-and-cross-references
 message: "The xref is missing an anchor ID."
 raw:
-  - 'xref(.*)(\.adoc)(?!\#)'
+  - '(?<!\/\/.*)xref(.*)(\.adoc)(?!\#)'
diff --git a/.vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml b/.vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml
index c1c1451b0..23f89dca5 100644
--- a/.vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml
+++ b/.vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml
@@ -5,4 +5,4 @@ level: error
 link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#links-hyperlinks-and-cross-references
 message: "Use .adoc instead of .html in xrefs"
 tokens:
-  - 'xref(.*)(\.html)#(.*)'
+  - '(?<!\/\/.*)xref(.*)(\.html)#(.*)'
diff --git a/antora-playbook.yml b/antora-playbook.yml
index b79f6780b..4cd07488b 100644
--- a/antora-playbook.yml
+++ b/antora-playbook.yml
@@ -20,7 +20,6 @@ content:
     - url: ./
       branches:
         - HEAD
-        - v*
       edit_url: "https://github.com/redhat-documentation/vale-at-red-hat/edit/main/{path}"
 antora:
   extensions:
diff --git a/modules/contributor-guide/nav.adoc b/modules/contributor-guide/nav.adoc
index f94a9012f..0e1f6e238 100644
--- a/modules/contributor-guide/nav.adoc
+++ b/modules/contributor-guide/nav.adoc
@@ -1,5 +1,4 @@
-.xref:contributor-guide.adoc[Vale at Red Hat contributor guide]
-
+.Vale at Red Hat contributor guide
 * xref:contributing.adoc[]
 * xref:vale-at-red-hat-repository.adoc[]
 * xref:extending-the-spelling-rule.adoc[]
diff --git a/modules/contributor-guide/pages/.placeholder b/modules/contributor-guide/pages/.placeholder
deleted file mode 100644
index e69de29bb..000000000
diff --git a/modules/contributor-guide/pages/contributor-guide.adoc b/modules/contributor-guide/pages/contributor-guide.adoc
deleted file mode 100644
index 29c0149c2..000000000
--- a/modules/contributor-guide/pages/contributor-guide.adoc
+++ /dev/null
@@ -1,6 +0,0 @@
-:navtitle: Contributor guide
-:keywords: reference, contributor
-
-= Vale at Red Hat contributor guide
-
-include::partial$nav.adoc[lines=3..]
diff --git a/modules/contributor-guide/partials/nav.adoc b/modules/contributor-guide/partials/nav.adoc
deleted file mode 120000
index 87c951c82..000000000
--- a/modules/contributor-guide/partials/nav.adoc
+++ /dev/null
@@ -1 +0,0 @@
-../nav.adoc
\ No newline at end of file
diff --git a/modules/reference-guide/nav.adoc b/modules/reference-guide/nav.adoc
index 0ecdd0449..d3bacce8a 100644
--- a/modules/reference-guide/nav.adoc
+++ b/modules/reference-guide/nav.adoc
@@ -1,5 +1,4 @@
-.xref:reference-guide.adoc[Vale rules reference guide]
-
+.Vale rules reference guide
 * xref:abbreviations.adoc[]
 * xref:casesensitiveterms.adoc[]
 * xref:conjunctions.adoc[]
diff --git a/modules/reference-guide/pages/reference-guide.adoc b/modules/reference-guide/pages/reference-guide.adoc
deleted file mode 100644
index 6bf48d0f8..000000000
--- a/modules/reference-guide/pages/reference-guide.adoc
+++ /dev/null
@@ -1,6 +0,0 @@
-:navtitle: Reference guide
-:keywords: reference, rule, list
-
-= Vale rules reference guide
-
-include::partial$nav.adoc[lines=3..]
diff --git a/modules/reference-guide/partials/nav.adoc b/modules/reference-guide/partials/nav.adoc
deleted file mode 120000
index 87c951c82..000000000
--- a/modules/reference-guide/partials/nav.adoc
+++ /dev/null
@@ -1 +0,0 @@
-../nav.adoc
\ No newline at end of file
diff --git a/modules/user-guide/nav.adoc b/modules/user-guide/nav.adoc
index a1eda0e8d..ffc98d033 100644
--- a/modules/user-guide/nav.adoc
+++ b/modules/user-guide/nav.adoc
@@ -1,5 +1,4 @@
-.xref:user-guide.adoc[Vale at Red Hat user guide]
-
+.Vale at Red Hat user guide
 * xref:introduction.adoc[]
 * xref:installing-vale-cli.adoc[]
 * xref:installing-redhat-style-for-vale.adoc[]
diff --git a/modules/user-guide/pages/.placeholder b/modules/user-guide/pages/.placeholder
deleted file mode 100644
index e69de29bb..000000000
diff --git a/modules/user-guide/pages/user-guide.adoc b/modules/user-guide/pages/user-guide.adoc
deleted file mode 100644
index 1d9f47e63..000000000
--- a/modules/user-guide/pages/user-guide.adoc
+++ /dev/null
@@ -1,6 +0,0 @@
-:navtitle: User guide
-:keywords: reference, user
-
-= Vale at Red Hat user guide
-
-include::partial$nav.adoc[lines=3..]
diff --git a/modules/user-guide/pages/using-vale-in-the-ide.adoc b/modules/user-guide/pages/using-vale-in-the-ide.adoc
index 25e7e9e72..3134b28f3 100644
--- a/modules/user-guide/pages/using-vale-in-the-ide.adoc
+++ b/modules/user-guide/pages/using-vale-in-the-ide.adoc
@@ -16,7 +16,7 @@ Consider using Vale in your IDE when:
 .Prerequisites
 
 * Vale CLI is installed and configured. See xref:installing-vale-cli.adoc[].
-* link:https://code.visualstudio.com/docs/setup/setup-overview[Visual Studio Code] is installed.
+* link:https://code.visualstudio.com/download[Visual Studio Code] is installed.
 
 .Procedure
 
diff --git a/modules/user-guide/partials/nav.adoc b/modules/user-guide/partials/nav.adoc
deleted file mode 120000
index 87c951c82..000000000
--- a/modules/user-guide/partials/nav.adoc
+++ /dev/null
@@ -1 +0,0 @@
-../nav.adoc
\ No newline at end of file