git: 2f32670633 - main - Introduce vale to the docs tree
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Thu, 10 Nov 2022 18:52:42 UTC
The branch main has been updated by bofh:
URL: https://cgit.FreeBSD.org/doc/commit/?id=2f326706331e23173f726dc3555cb74c9d23696d
commit 2f326706331e23173f726dc3555cb74c9d23696d
Author: Muhammad Moinur Rahman <bofh@FreeBSD.org>
AuthorDate: 2022-11-10 18:43:50 +0000
Commit: Muhammad Moinur Rahman <bofh@FreeBSD.org>
CommitDate: 2022-11-10 18:52:31 +0000
Introduce vale to the docs tree
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
---
.vale.ini | 48 +
.../Dicts/en_US-default_none_strip_hacker.aff | 205 +
.../Dicts/en_US-default_none_strip_hacker.dic | 49568 +++++++++++++++++++
.vale/styles/FreeBSD/BrandTerms.yml | 11 +
.vale/styles/FreeBSD/ConsciousLanguage.yml | 36 +
.vale/styles/FreeBSD/Contractions.yml | 42 +
.vale/styles/FreeBSD/EOLSpacing.yml | 7 +
.vale/styles/FreeBSD/Hang.yml | 12 +
.vale/styles/FreeBSD/Hyphens.yml | 13 +
.vale/styles/FreeBSD/Repitition.yml | 6 +
.vale/styles/FreeBSD/Spacing.yml | 7 +
.vale/styles/FreeBSD/Spelling.yml | 7 +
.vale/styles/FreeBSD/Weasel.yml | 208 +
.vale/styles/FreeBSD/spelling-exceptions.txt | 79 +
.vale/vale.tmpl | 40 +
15 files changed, 50289 insertions(+)
diff --git a/.vale.ini b/.vale.ini
new file mode 100644
index 0000000000..2566579071
--- /dev/null
+++ b/.vale.ini
@@ -0,0 +1,48 @@
+StylesPath = .vale/styles
+MinAlertLevel = suggestion
+
+[asciidoctor]
+# enable
+experimental = YES
+
+# assign a specific value
+attribute-missing = drop
+
+[*.adoc]
+BasedOnStyles = FreeBSD
+FreeBSD.BrandTerms = NO
+FreeBSD.ConsciousLanguage = NO
+FreeBSD.Contractions = NO
+FreeBSD.EOLSpacing = NO
+FreeBSD.Hang = NO
+FreeBSD.Hyphens = NO
+FreeBSD.Repitition = NO
+FreeBSD.Spacing = NO
+FreeBSD.Spelling = NO
+FreeBSD.Weasel = NO
+
+[website/content/en/**/*.adoc]
+BasedOnStyles = FreeBSD
+FreeBSD.BrandTerms = YES
+FreeBSD.ConsciousLanguage = YES
+FreeBSD.Contractions = YES
+FreeBSD.EOLSpacing = YES
+FreeBSD.Hang = YES
+FreeBSD.Hyphens = YES
+FreeBSD.Repitition = YES
+FreeBSD.Spacing = YES
+FreeBSD.Spelling = YES
+FreeBSD.Weasel = NO
+
+[documentation/content/en/**/*.adoc]
+BasedOnStyles = FreeBSD
+FreeBSD.BrandTerms = YES
+FreeBSD.ConsciousLanguage = YES
+FreeBSD.Contractions = YES
+FreeBSD.EOLSpacing = YES
+FreeBSD.Hang = YES
+FreeBSD.Hyphens = YES
+FreeBSD.Repitition = YES
+FreeBSD.Spacing = YES
+FreeBSD.Spelling = YES
+FreeBSD.Weasel = NO
diff --git a/.vale/styles/Dicts/en_US-default_none_strip_hacker.aff b/.vale/styles/Dicts/en_US-default_none_strip_hacker.aff
new file mode 100644
index 0000000000..d0cccb3dc7
--- /dev/null
+++ b/.vale/styles/Dicts/en_US-default_none_strip_hacker.aff
@@ -0,0 +1,205 @@
+SET UTF-8
+TRY esianrtolcdugmphbyfvkwzESIANRTOLCDUGMPHBYFVKWZ'
+ICONV 1
+ICONV ’ '
+NOSUGGEST !
+
+# ordinal numbers
+COMPOUNDMIN 1
+# only in compounds: 1th, 2th, 3th
+ONLYINCOMPOUND c
+# compound rules:
+# 1. [0-9]*1[0-9]th (10th, 11th, 12th, 56714th, etc.)
+# 2. [0-9]*[02-9](1st|2nd|3rd|[4-9]th) (21st, 22nd, 123rd, 1234th, etc.)
+COMPOUNDRULE 2
+COMPOUNDRULE n*1t
+COMPOUNDRULE n*mp
+WORDCHARS 0123456789
+
+PFX A Y 1
+PFX A 0 re .
+
+PFX I Y 1
+PFX I 0 in .
+
+PFX U Y 1
+PFX U 0 un .
+
+PFX C Y 1
+PFX C 0 de .
+
+PFX E Y 1
+PFX E 0 dis .
+
+PFX F Y 1
+PFX F 0 con .
+
+PFX K Y 1
+PFX K 0 pro .
+
+SFX V N 2
+SFX V e ive e
+SFX V 0 ive [^e]
+
+SFX N Y 3
+SFX N e ion e
+SFX N y ication y
+SFX N 0 en [^ey]
+
+SFX X Y 3
+SFX X e ions e
+SFX X y ications y
+SFX X 0 ens [^ey]
+
+SFX H N 2
+SFX H y ieth y
+SFX H 0 th [^y]
+
+SFX Y Y 1
+SFX Y 0 ly .
+
+SFX G Y 2
+SFX G e ing e
+SFX G 0 ing [^e]
+
+SFX J Y 2
+SFX J e ings e
+SFX J 0 ings [^e]
+
+SFX D Y 4
+SFX D 0 d e
+SFX D y ied [^aeiou]y
+SFX D 0 ed [^ey]
+SFX D 0 ed [aeiou]y
+
+SFX T N 4
+SFX T 0 st e
+SFX T y iest [^aeiou]y
+SFX T 0 est [aeiou]y
+SFX T 0 est [^ey]
+
+SFX R Y 4
+SFX R 0 r e
+SFX R y ier [^aeiou]y
+SFX R 0 er [aeiou]y
+SFX R 0 er [^ey]
+
+SFX Z Y 4
+SFX Z 0 rs e
+SFX Z y iers [^aeiou]y
+SFX Z 0 ers [aeiou]y
+SFX Z 0 ers [^ey]
+
+SFX S Y 4
+SFX S y ies [^aeiou]y
+SFX S 0 s [aeiou]y
+SFX S 0 es [sxzh]
+SFX S 0 s [^sxzhy]
+
+SFX P Y 3
+SFX P y iness [^aeiou]y
+SFX P 0 ness [aeiou]y
+SFX P 0 ness [^y]
+
+SFX M Y 1
+SFX M 0 's .
+
+SFX B Y 3
+SFX B 0 able [^aeiou]
+SFX B 0 able ee
+SFX B e able [^aeiou]e
+
+SFX L Y 1
+SFX L 0 ment .
+
+REP 90
+REP a ei
+REP ei a
+REP a ey
+REP ey a
+REP ai ie
+REP ie ai
+REP alot a_lot
+REP are air
+REP are ear
+REP are eir
+REP air are
+REP air ere
+REP ere air
+REP ere ear
+REP ere eir
+REP ear are
+REP ear air
+REP ear ere
+REP eir are
+REP eir ere
+REP ch te
+REP te ch
+REP ch ti
+REP ti ch
+REP ch tu
+REP tu ch
+REP ch s
+REP s ch
+REP ch k
+REP k ch
+REP f ph
+REP ph f
+REP gh f
+REP f gh
+REP i igh
+REP igh i
+REP i uy
+REP uy i
+REP i ee
+REP ee i
+REP j di
+REP di j
+REP j gg
+REP gg j
+REP j ge
+REP ge j
+REP s ti
+REP ti s
+REP s ci
+REP ci s
+REP k cc
+REP cc k
+REP k qu
+REP qu k
+REP kw qu
+REP o eau
+REP eau o
+REP o ew
+REP ew o
+REP oo ew
+REP ew oo
+REP ew ui
+REP ui ew
+REP oo ui
+REP ui oo
+REP ew u
+REP u ew
+REP oo u
+REP u oo
+REP u oe
+REP oe u
+REP u ieu
+REP ieu u
+REP ue ew
+REP ew ue
+REP uff ough
+REP oo ieu
+REP ieu oo
+REP ier ear
+REP ear ier
+REP ear air
+REP air ear
+REP w qu
+REP qu w
+REP z ss
+REP ss z
+REP shun tion
+REP shun sion
+REP shun cion
+REP size cise
diff --git a/.vale/styles/Dicts/en_US-default_none_strip_hacker.dic b/.vale/styles/Dicts/en_US-default_none_strip_hacker.dic
new file mode 100644
index 0000000000..642af8e2a7
--- /dev/null
+++ b/.vale/styles/Dicts/en_US-default_none_strip_hacker.dic
@@ -0,0 +1,49568 @@
+49567
+0/nm
+0th/pt
+1/n1
+1st/p
+1th/tc
+2/nm
+2nd/p
+2th/tc
+3/nm
+3rd/p
+3th/tc
+4/nm
+4th/pt
+5/nm
+5th/pt
+6/nm
+6th/pt
+7/nm
+7th/pt
+8/nm
+8th/pt
+9/nm
+9th/pt
+A/SM
+AA/M
+AAA
+AB/M
+ABA
+ABC/SM
+ABM/SM
+ABS
+AC/M
+ACLU/M
+ACT
+ACTH/M
+AD/M
+ADC
+ADD
+ADM
+ADP/M
+AF
+AFAIK
+AFB
+AFC/M
+AFDC
+AFN
+AFT
+AI/SM
+AIDS/M
+AK
+AL
+AM/M
+AMA
+AMD/M
+ANSI/S
+ANZUS/M
+AOL/M
+AP/M
+APB
+APC
+API
+APO
+APR
+AR
+ARC
+ASAP
+ASCII/SM
+ASL/M
+ASPCA
+ATM/M
+ATP/M
+ATV
+AV
+AVI
+AWACS/M
+AWOL/M
+AWS/M
+AZ/M
+AZT/M
+Aachen/M
+Aaliyah/M
+Aaron/M
+Abbas/M
+Abbasid/M
+Abbott/M
+Abby/M
+Abdul/M
+Abe/M
+Abel/M
+Abelard/M
+Abelson/M
+Aberdeen/M
+Abernathy/M
+Abidjan/M
+Abigail/M
+Abilene/M
+Abner/M
+Aborigine/MS
+Abraham/M
+Abram/MS
+Abrams/M
+Absalom/M
+Abuja/M
+Abyssinia/M
+Abyssinian/M
+Ac/M
+Acadia/M
+Acapulco/M
+Accenture/M
+Accra/M
+Acevedo/M
+Achaean/M
+Achebe/M
+Achernar/M
+Acheson/M
+Achilles/M
+Aconcagua/M
+Acosta/M
+Acropolis
+Acrux/M
+Actaeon/M
+Acton/M
+Acts/M
+Acuff/M
+Ada/SM
+Adam/SM
+Adams/M
+Adan/M
+Adana/M
+Adar/M
+Addams/M
+Adderley/M
+Addie/M
+Addison/M
+Adela/M
+Adelaide/M
+Adele/M
+Adeline/M
+Aden/M
+Adenauer/M
+Adhara/M
+Adidas/M
+Adirondack/MS
+Adirondacks/M
+Adkins/M
+Adler/M
+Adm
+Admiralty
+Adolf/M
+Adolfo/M
+Adolph/M
+Adonis/MS
+Adrenalin/MS
+Adrian/M
+Adriana/M
+Adriatic/M
+Adrienne/M
+Advent/MS
+Adventist/MS
+Advil/M
+Aegean/M
+Aelfric/M
+Aeneas/M
+Aeneid/M
+Aeolus/M
+Aeroflot/M
+Aeschylus/M
+Aesculapius/M
+Aesop/M
+Afghan/SM
+Afghani/M
+Afghanistan/M
+Afr
+Africa/M
+African/SM
+Afrikaans/M
+Afrikaner/SM
+Afro/SM
+Afrocentric
+Afrocentrism/M
+Ag/M
+Agamemnon/M
+Agana
+Agassi/M
+Agassiz/M
+Agatha/M
+Aggie/M
+Aglaia/M
+Agnes/M
+Agnew/M
+Agni/M
+Agra/M
+Agricola/M
+Agrippa/M
+Agrippina/M
+Aguadilla/M
+Aguascalientes
+Aguilar/M
+Aguinaldo/M
+Aguirre/M
+Agustin/M
+Ahab/M
+Ahmad/M
+Ahmadabad/M
+Ahmadinejad/M
+Ahmed/M
+Ahriman/M
+Aida/M
+Aiken/M
+Aileen/M
+Aimee/M
+Ainu/M
+Airedale/MS
+Aires/M
+Aisha/M
+Ajax/M
+Akbar/M
+Akhmatova/M
+Akihito/M
+Akita/M
+Akiva/M
+Akkad/M
+Akron/M
+Al/M
+Ala/S
+Alabama/M
+Alabaman/MS
+Alabamian/SM
+Aladdin/M
+Alamo/M
+Alamogordo/M
+Alan/M
+Alana/M
+Alar/M
+Alaric/M
+Alaska/M
+Alaskan/MS
+Alba/M
+Albania/M
+Albanian/MS
+Albany/M
+Albee/M
+Alberio/M
+Albert/M
+Alberta/M
+Albertan
+Alberto/M
+Albigensian/M
+Albion/M
+Albireo/M
+Albuquerque/M
+Alcatraz/M
+Alcestis/M
+Alcibiades/M
+Alcindor/M
+Alcmena/M
+Alcoa/M
+Alcott/M
+Alcuin/M
+Alcyone/M
+Aldan/M
+Aldebaran/M
+Alden/M
+Alderamin/M
+Aldo/M
+Aldrin/M
+Alec/M
+Aleichem/M
+Alejandra/M
+Alejandro/M
+Alembert/M
+Aleppo/M
+Aleut/MS
+Aleutian/SM
+Alex/M
+Alexander/MS
+Alexandra/M
+Alexandria/M
+Alexandrian
+Alexei/M
+Alexis/M
+Alfonso/M
+Alfonzo/M
+Alford/M
+Alfred/M
+Alfreda/M
+Alfredo/M
+Algenib/M
+Alger/M
+Algeria/M
+Algerian/SM
+Algieba/M
+Algiers/M
+Algol/M
+Algonquian/SM
+Algonquin/MS
+Alhambra/M
+Alhena/M
+Ali/M
+Alice/M
+Alicia/M
+Alighieri/M
+Aline/M
+Alioth/M
+Alisa/M
+Alisha/M
+Alison/M
+Alissa/M
+Alistair/M
+Alkaid/M
+Allah/M
+Allahabad/M
+Allan/M
+Alleghenies/M
+Allegheny/SM
+Allegra/M
+Allen/M
+Allende/M
+Allentown/M
+Allhallows/M
+Allie/MS
+Allison/M
+Allstate/M
+Allyson/M
+Alma/M
+Almach/M
+Almaty/M
+Almighty/M
+Almohad/M
+Almoravid/M
+Alnilam/M
+Alnitak/M
+Alonzo/M
+Alpert/M
+Alphard/M
+Alphecca/M
+Alpheratz/M
+Alphonse/M
+Alphonso/M
+Alpine/M
+Alpo/M
+Alps/M
+Alsace/M
+Alsatian/SM
+Alsop/M
+Alston/M
+Alta/M
+Altaba/M
+Altai/M
+Altaic/M
+Altair/M
+Altamira/M
+Althea/M
+Altiplano/M
+Altman/M
+Altoids/M
+Alton/M
+Altoona/M
+Aludra/M
+Alva/M
+Alvarado/M
+Alvarez/M
+Alvaro/M
+Alvin/M
+Alyce/M
+Alyson/M
+Alyssa/M
+Alzheimer/M
+Am/MNR
+Amadeus/M
+Amado/M
+Amalia/M
+Amanda/M
+Amarillo/M
+Amaru/M
+Amaterasu/M
+Amati/M
+Amazon/SM
+Amazonian
+Amber/M
+Amelia/M
+Amen/M
+Amenhotep/M
+Amerasian/M
+America/SM
+American/MS
+Americana/M
+Americanism/SM
+Americanization/SM
+Americanize/DSG
+Amerind/SM
+Amerindian/SM
+Ames/M
+Ameslan/M
+Amgen/M
+Amharic/M
+Amherst/M
+Amie/M
+Amiga/M
+Amish/M
+Amman/M
+Amoco/M
+Amos/M
+Amparo/M
+Ampere/M
+Amritsar/M
+Amsterdam/M
+Amtrak/M
+Amundsen/M
+Amur/M
+Amway/M
+Amy/M
+Ana/M
+Anabaptist/M
+Anabel/M
+Anacin/M
+Anacreon/M
+Anaheim/M
+Analects/M
+Ananias/M
+Anasazi/M
+Anastasia/M
+Anatole/M
+Anatolia/M
+Anatolian/M
+Anaxagoras/M
+Anchorage/M
+Andalusia/M
+Andalusian/M
+Andaman/M
+Andean/M
+Andersen/M
+Anderson/M
+Andes/M
+Andorra/M
+Andorran/SM
+Andre/MS
+Andrea/M
+Andrei/M
+Andres/M
+Andretti/M
+Andrew/SM
+Andrews/M
+Andrianampoinimerina/M
+Android/M
+Andromache/M
+Andromeda/M
+Andropov/M
+Andy/M
+Angara/M
+Angel/M
+Angela/M
+Angeles/M
+Angelia/M
+Angelica/M
+Angelico/M
+Angelina/M
+Angeline/M
+Angelique/M
+Angelita/M
+Angelo/M
+Angelou/M
+Angevin/M
+Angie/M
+Angkor/M
+Angle/MS
+Angleton/M
+Anglia/M
+Anglican/SM
+Anglicanism/MS
+Anglicism/MS
+Anglicization
+Anglicize
+Anglo/M
+Anglophile/M
+Anglophobe
+Angola/M
+Angolan/MS
+Angora/SM
+Angstrom/M
+Anguilla/M
+Angus/M
+Anhui/M
+Aniakchak/M
+Anibal/M
+Anita/M
+Ankara/M
+Ann/M
+Anna/M
+Annabel/M
+Annabelle/M
+Annam/M
+Annapolis/M
+Annapurna/M
+Anne/M
+Annette/M
+Annie/M
+Anniston/M
+Annmarie/M
+Annunciation/MS
+Anouilh/M
+Anselm/M
+Anselmo/M
+Anshan/M
+Antaeus/M
+Antananarivo/M
+Antarctic/M
+Antarctica/M
+Antares/M
+Anthony/M
+Anthropocene
+Antichrist/MS
+Antietam/M
+Antifa/M
+Antigone/M
+Antigua/M
+Antillean
+Antilles/M
+Antioch/M
+Antipas/M
+Antipodes
+Antofagasta/M
+Antoine/M
+Antoinette/M
+Anton/M
+Antone/M
+Antonia/M
+Antoninus/M
+Antonio/M
+Antonius/M
+Antony/M
+Antwan/M
+Antwerp/M
+Anubis/M
+Anzac/M
+Apache/SM
+Apalachicola/M
+Apatosaurus
+Apennines/M
+Aphrodite/M
+Apia/M
+Apocalypse/M
+Apocrypha/M
+Apollinaire/M
+Apollo/SM
+Apollonian/M
+Apostle/M
+Appalachia/M
+Appalachian/MS
+Appalachians/M
+Appaloosa/SM
+Apple/M
+Appleseed/M
+Appleton/M
+Appomattox/M
+Apr/M
+April/MS
+Apuleius/M
+Aquafresh/M
+Aquarian
+Aquarius/MS
+Aquila/M
+Aquinas/M
+Aquino/M
+Aquitaine/M
+Ar/M
+Ara/M
+Arab/SM
+Arabia/M
+Arabian/MS
+Arabic/M
+Arabist/MS
+Araby/M
+Araceli/M
+Arafat/M
+Aragon
+Araguaya/M
+Aral/M
+Aramaic/M
+Aramco/M
+Arapaho/MS
+Arapahoes
+Ararat/M
+Araucanian/M
+Arawak/M
+Arawakan/M
+Arbitron/M
+Arcadia/M
+Arcadian/M
+Archean/M
+Archibald/M
+Archie/M
+Archimedes/M
+Arctic/M
+Arcturus/M
+Ardabil
+Arden/M
+Arduino/M
+Arecibo/M
+Arequipa/M
+Ares/M
+Argentina/M
+Argentine/M
+Argentinean
+Argentinian/MS
+Argo/SM
+Argonaut/MS
+Argonne/M
+Argos/M
+Argus/M
+Ariadne/M
+Arianism/M
+Ariel/M
+Aries/MS
+Ariosto/M
+Aristarchus/M
+Aristides/M
+Aristophanes/M
+Aristotelian/M
+Aristotle/M
+Arius/M
+Ariz
+Arizona/M
+Arizonan/SM
+Arizonian/MS
+Arjuna/M
+Ark/M
+Arkansan/MS
+Arkansas/M
+Arkhangelsk/M
+Arkwright/M
+Arlene/M
+Arline/M
+Arlington/M
+Armageddon/SM
+Armagnac/M
+Armand/M
*** 49470 LINES SKIPPED ***