Skip to content

Commit

Permalink
Merge pull request #709 from aireilly/update-vale-install
Browse files Browse the repository at this point in the history
Updating install instructions for Vale 3
  • Loading branch information
aireilly authored Jan 25, 2024
2 parents b748c91 + edeb0c0 commit d3b6310
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions modules/user-guide/pages/installing-vale-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,41 @@ Install the Vale linter and the `RedHat` package to automate reviewing content f

[IMPORTANT]
====
Vale v3.0.0+ introduces a breaking change in how the Styles path is configured.
Until we reconcile these changes, use Vale v2.30.0 or lower.
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:
[source,terminal]
----
.vale/styles/config/vocabularies/<project_vocab_folder>
----
====

.Prerequisites

* Install the link:https://docs.asciidoctor.org/asciidoctor/latest/install/[Asciidoctor] Ruby gem.
* Remove any previously installed `mczernek/vale` RPM installation. Fedora 39 CSB is not compatible with the latest `mczernek/vale` RPM.
To remove a previous Vale RPM installation, do the following:
.Procedure

. Install Vale.
For RHEL or Fedora Linux operating systems, run the following command:
+
[source,terminal]
----
sudo dnf remove vale
$ sudo dnf copr enable mczernek/vale && sudo dnf install vale
----

.Procedure

. To install the Vale v2.30.0 command-line tool on RHEL or Fedora, run the following commands:
. Verify the Vale install location.
You might need to update your text editor with this value.
+
[source,terminal]
----
wget https://github.com/errata-ai/vale/releases/download/v2.30.0/vale_2.30.0_Linux_64-bit.tar.gz

tar xzvf vale_2.30.0_Linux_64-bit.tar.gz vale -C ${HOME}/bin

echo "Installed $(vale --version) to ${HOME}/bin/vale"
$ which vale
----
+
.Example output
[source,terminal]
----
/usr/bin/vale
----
+
[NOTE]
Expand Down

0 comments on commit d3b6310

Please sign in to comment.