Zen

Source string Source string

618/10000 · 618

The string is read only.

English Actions
Use Vale to check files or directories
To use Vale, do the following:
Create or edit a file in your local Fedora Docs repository. See xref:contributing-docs/tools-local-authoring-env.adoc[How to create and use a local Fedora authoring environment] for instructions on how to fork, clone, and manage Git repositories on your computer.
Run the Vale linter on the file. You can run Vale on a single file, several files, and directories.
Make updates to the file to fix any errors, warnings, or suggestions.
Rerun the Vale linter to verify the file passes.
When your file passes, you can commit your work and push to your fork on GitLab, and open a merge request.
Vale commands and output
To run Vale on a single file:
$ vale filename
To run Vale on several files:
$ vale filename 1 filename 2
To run Vale on all the files in a directory:
$ vale directoryname/
Vale will return a list of results showing the location in the file, the level of severity, a hint about how to correct the result, and what style reference flagged the result. For example:
11:1 suggestion Define acronyms and RedHat.Definitions
abbreviations (such as 'TOC')
on first occurrence if they're
likely to be unfamiliar.
15:54 error Use 'for example' rather than RedHat.TermsErrors
'e.g.'.
15:59 warning Use correct American English RedHat.Spelling
spelling. Did you really mean
'Quickdocs'?
If a file returns a long list of results, use:
$ vale --no-wrap filename
This will print each result on one line. This is also useful when checking many files or all the files in a directory.
Vale has three levels of results that it will list at the bottom of the output: error, warning, and suggestion.
`✖ 1 error, 3 warnings and 4 suggestions in 1 file.`
**error**: This is a blocker, and you must fix any errors found in the file.
**warning**: This is a not a blocker, but is something that you need to fix to conform to the Red Hat style guide.
**suggestion**: This is not a blocker, but is something you must review and try to fix to conform to the Red Hat style guide.
If you want to only look for a specific result, use the `--minAlertLevel level` flag. This is useful if you have a long list of results and want to work on one specific result level at a time.
`--minAlertLevel suggestion` (shows suggestion, warning, and error)
`--minAlertLevel warning` (shows warning and error)
`--minAlertLevel error` (shows only error)
For example, to only shows results flagged with error in the file, use:
$ vale --no-wrap --minAlertLevel error filename
How to interpret Vale results

Loading…

User avatar None

String updated in the repository
11:1 suggestion Define acronyms and RedHat.Definitions
abbreviations (such as 'TOC')
on first occurrence if they're
likely to be unfamiliar.
15:54 error Use 'for example' rather than RedHat.TermsErrors
'e.g.'.
15:59 warning Use correct American English RedHat.Spelling
spelling. Did you really mean
'Quickdocs'?
11:1 suggestion Define acronyms and RedHat.Definitions
abbreviations (such as 'TOC')
on first occurrence if they're
likely to be unfamiliar.
15:54 error Use 'for example' rather than RedHat.TermsErrors
'e.g.'.
15:59 warning Use correct American English RedHat.Spelling
spelling. Did you really mean
'Quickdocs'?
a year ago
Browse all string changes

Things to check

Long untranslated

The string has not been translated for a long time

Reset

Glossary

English English
No related strings found in the glossary.

12343938 String information

Source string description
type: delimited block -
Flags
no-wrap, read-only
Source string location
./pages/contributing-docs/tools-vale-linter.adoc:80
String age
a year ago
Last updated
3 months ago
Source string age
a year ago
Translation file
pot/master/pages/contributing-docs/tools-vale-linter.pot, string 30