Updating docs

redhat-documentation · Aug 27, 2024 · eb6e515 · eb6e515
1 parent d2fff2c
commit eb6e515
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/modules/user-guide/pages/installing-redhat-style-for-vale.adoc b/modules/user-guide/pages/installing-redhat-style-for-vale.adoc
@@ -9,6 +9,11 @@
 
 You can install the `RedHat` style for Vale globally.
 
+[IMPORTANT]
+====
+The `RedHat` style for Vale is compatible with Vale version 3.7 and above.
+====
+
 [IMPORTANT]
 ====
 Some product documentation repositories, such as `openshift-docs`, have an existing `.vale.ini` file.

diff --git a/modules/user-guide/pages/installing-vale-cli.adoc b/modules/user-guide/pages/installing-vale-cli.adoc
@@ -19,6 +19,20 @@ The project will already have a `vale.ini` configuration.
 
 * Install the link:https://docs.asciidoctor.org/asciidoctor/latest/install/[Asciidoctor] Ruby gem.
 
+* If you have previously installed Vale, you can check what version you are currently running.
+Run the following command:
++
+[source,terminal]
+----
+$ vale --version
+----
++
+.Example output
+[source,terminal]
+----
+vale version 3.6.1
+----
+
 .Procedure
 
 . Install Vale.
@@ -51,7 +65,9 @@ $ which vale
 ----
 +
 [NOTE]
+====
 For other operating systems, see link:https://vale.sh/docs/vale-cli/installation/[Installing Vale].
+====
 
 .Additional resources
 * xref:understanding-vale-output.adoc[]

diff --git a/modules/user-guide/pages/redhat-style-for-vale.adoc b/modules/user-guide/pages/redhat-style-for-vale.adoc
@@ -8,7 +8,7 @@
 [id="redhat-style-for-vale"]
 = Red Hat style for Vale
 
-The `RedHat` style for Vale consists of language rules suitable for documentation in Open Source projects and mandatory for Red Hat products. These language rules originates from:
+The `RedHat` style for Vale consists of language rules suitable for documentation in Open Source projects and mandatory for Red Hat products. The Vale language rules originate from:
 
 * link:{ssg-url}[_{ssg}_]
 * Latest edition of the _{ibmsg}_
@@ -17,6 +17,8 @@ The `RedHat` style for Vale consists of language rules suitable for documentatio
 
 [IMPORTANT]
 ====
+The `RedHat` style for Vale is compatible with Vale version 3.7 and above.
+
 Vale v3 introduced a breaking change for the Vale vocabulary folder location.
 For Vale v3+, if you use a vocabulary with your project, ensure that the vocabulary folder matches this folder structure: