| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
| |
e.g/eg or ie/i.e actually hails from Latin root and do not have any
specific general acceptance in any English standards or at least should
not be written in technical documentation. But we have a lot of these in
our documentation. Throw errors for such occurrences and replace those
with for example or that is.
Approved by: carlavilla
|
| |
|
|
|
|
|
|
|
|
| |
After some careful consideration and thoughts the Weasel rule is being
removed because currently there are 18805 suggestions which will be
really time consuming to fix as rewording the sentences from weasel
words are a bit complicated.
Approved by: bcr (mentor)
Differential Revision: https://reviews.freebsd.org/D40063
|
| |
|
|
|
|
|
|
| |
Add various pronouns and their sub derivatives which are widely used in
our websites and documentation specially the usage of you.
Approved by: bcr (mentor)
Differential Revision: https://reviews.freebsd.org/D40029
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
- Remove spelling-exceptions list
- Vale has it's own engine to add custom vocabulary for adding project
specific keywords. Add a vocabulary named Terms
- Add the file accept.txt which words should be accepted without any
errors
- Utilize documentation/content/en/books/arch-handbook/mac/_index.adoc
as proof of concept to remove all sort of errors/warnings/suggestion.
- Remove EOLSpace
- Fix Semantic Line Breakings
- Add relevant keywords to the new Vocab file accept.txt
- Some codewords were not marked with single tick ` so mark those properly
that spelling engine do not throw errors
Approved by: carlavilla (mentor)
Differential Revision: https://reviews.freebsd.org/D39703
|
| |
|
|
|
|
|
|
|
| |
Vale's file globbing is much more stronger than thought while designing
for our documentation project or has improved significantly. Reduce the
clutter of rules in .vale.ini.
Approved by: bcr (mentor)
Differential Revision: https://reviews.freebsd.org/D39798
|
| |
|
|
|
|
|
|
| |
Vale now comes with it's own Repetition rules. Utilize that rule instead
of the FreeBSD one and also remove the FreeBSD rule of Repititon.
Approved by: carlavilla (mentor)
Differential Revision: https://reviews.freebsd.org/D39704
|
| |
|
|
|
|
|
|
|
| |
Suggest to empty square brackets in `link:` macros when the displayed
text coincides with the URL.
Reviewed by: bofh, grahamperrin
Approved by: carlavilla (mentor)
Differential Revision: https://reviews.freebsd.org/D39569
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
In some older documents there are code snippets with the following tags
which are non standard for asciidoc:
[.programlisting]
....
CODE
....
As this is non-standard vale does not escape this and finds spelling
error but these blocks should be ignored by vale. This patch adds
relevant directives to ignore the blocks.
Approved by: carlavilla (mentor)
Differential Revision: https://reviews.freebsd.org/D39702
|
| |
|
|
|
|
|
|
|
|
| |
Initially it was considered that EOL Spaces were only available in the
en language but after running vale on the entire set other languages are
also affected by this. So enable EOLSpacing check for other language
sets.
Approved by: carlavilla (mentor)
Differential Revision: https://reviews.freebsd.org/D39701
|
| |
|
|
|
|
|
|
|
| |
Other non English languages might have other punctuation symbols which
might conflict with this rule. So disable this rule for other Non
English languages.
Approved by: carlavilla (mentor)
Differential Revision: https://reviews.freebsd.org/D39700
|
| |
|
|
|
|
|
|
|
| |
Vale started shipping with a dictionary(en_US) of it's own which looks
like good enough for our purpose. So this patch removes the FreeBSD
Custom Dictionary and uses the Vale's stock one.
Approved by: carlavilla (mentor)
Differential Revision: https://reviews.freebsd.org/D39694
|
| |
|
|
|
|
|
|
|
|
| |
Previous commit of .vale.ini was not helpful for editor integration as
vim creates a file outside the git repository(specially /tmp) where vale
styles were not applicable. This commit changes the applicable file
patterns to match editor integration.
Approved by: bcr
Differential Revision: https://reviews.freebsd.org/D37362
|
|
|
Currently we do not have any language checker for our documentation
system. In previous we used igor which has not been upgraded and
sometimes are also not compatible with AsciiDOC and additionally the
maintainer is no longer a committer anymore. Considering this and
widespread use of Vale we have given a test on vale and initiating
introduction of vale with some basic set of rules. The rules are
described as below:
BrandTerms: Like The FreeBSD Project every major vendors and Companies
have specific rules on writing their Brand Name. Although we never read
but according to the Copyright rules of The FreeBSD Foundation whenever
we are writing we should write FreeBSD rather than freebsd. That is our
brand value. Similar to that we should be respective to other's brand
value and write PostgreSQL, Node.js, Let's Encrypt etc.
Contractions: Contracted words should not be used. This rule avoids all
contractions and suggests full words.
Hang: We often try to use the word hang to convey the meaning that the
application has stopped responding. This rule proposes better wording
Repetition: Often while working we type the same words twice; this
mostly happen we leave the keyboard while writing and returning to desk.
This rule finds repeated words
Weasel: This rule handles avoiding weasel words
ConsciousLanguage: This rule proposes uses of conscious languages like
avoiding the words white/black/master/slave
EOLSpacing: In most of our documents EOL spacing is present which is
not the ideal situation. This rule warns the user
Hyphens: Often adverbs ending with 'ly' are being added with a hyphen
which is wrong. This rule handles this
Spacing: Often double spaces are hard to catch on plain eye which is addressed here
Spelling: Spelling checks using a custom dictionary from
http://wordlist.aspell.net which uses strictly en_US and do not accept
the BRITISH spelling variant. It has also an exception list to ignore
the FreeBSD specific terms. Currently the list is a basic one with
minimal words just as a proof of concept
The next step will be restarting the CI process of FreeBSD docs, reduce
noises and implement git hooks.
Approved by: carlavilla (mentor)
Differential Revision: https://reviews.freebsd.org/D37297
|
