Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating docs to recommend minimum version for using Vale with VRH #873

Merged
merged 1 commit into from
Aug 27, 2024
Merged

Updating docs to recommend minimum version for using Vale with VRH #873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions modules/user-guide/pages/installing-redhat-style-for-vale.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
16 changes: 16 additions & 0 deletions modules/user-guide/pages/installing-vale-cli.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----

Copy link
Collaborator

@rolfedh rolfedh Aug 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good information! However, it may not align with the experience of Red Hat users who follow the installation instructions for Linux users at vale.sh, which use snap. In that case, users typically see:

[rdlugyhe@rdlugyhe-thinkpadt14sgen2i ~]$ which vale
/var/lib/snapd/snap/bin/vale
[rdlugyhe@rdlugyhe-thinkpadt14sgen2i ~]$ vale --version
vale version master

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The snap package manager automatically gets and runs the latest version of the package being run by the user.

Copy link
Member Author

@aireilly aireilly Aug 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Snap is an additional package manager that is not installed by default in Fedora OS. Seems strange that the vale install does not report the version though. That is odd.

Also I just installed snap on F40, and got this error:

$ sudo snap install vale
error: too early for operation, device not yet seeded or device model not acknowledged

For RHEL and Fedora, see https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/installing-vale-cli/

Copy link
Collaborator

@rolfedh rolfedh Aug 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got that on the first try immediately after installing snap. I reran the command and the issue cleared.

.Procedure

. Install Vale.
Expand Down Expand Up @@ -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[]
Expand Down
5 changes: 4 additions & 1 deletion modules/user-guide/pages/redhat-style-for-vale.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
[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.
aireilly marked this conversation as resolved.
Show resolved Hide resolved
The Red Hat language rules originate from:

* link:{ssg-url}[_{ssg}_]
* Latest edition of the _{ibmsg}_
Expand All @@ -17,6 +18,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.
aireilly marked this conversation as resolved.
Show resolved Hide resolved

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:

Expand Down