jonashub/team-docs
1
0
Fork 0
forked from docs/team-docs
Code Pull requests Activity

add abstract on vale guide

Browse source 
Signed-off-by: Hank Lee <allegrovelo@gmail.com>
This commit is contained in:
hank L 2024-08-29 20:45:47 +01:00
commit e15fba9e48
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
modules/ROOT/pages/contributing-docs/tools-vale-linter.adoc
View file

@ -1,10 +1,9 @@
= Check Your Documentation Using Vale
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
v0.0.1, 2022-12-17
v1.1, 2024-08-30
Before creating a merge request for any documentation or documentation updates, you will need to run https://vale.sh[Vale] on your text.
Vale is a command line tool that checks your text for adherence to a defined style guide. Fedora documentation uses the https://stylepedia.net/style/5.1/[Red Hat] style guide.
[abstract]
Vale is a command-line tool that allows you to check your writing for grammar and stylistic errors against a set of style rules. Vale codifies your style guides into a collection of Vale-compatible YAML files and it is highly customizable. Fedora documentation uses the https://stylepedia.net/style/5.1/[Red Hat] style guide. Before creating a merge request for any documentation or documentation updates, you will need to run https://vale.sh[Vale] on your text.
== Install Vale on your computer