diff --git a/.github/workflows/docs-lint.yaml b/.github/workflows/docs-lint.yaml new file mode 100644 index 000000000000..6838daff1a0e --- /dev/null +++ b/.github/workflows/docs-lint.yaml @@ -0,0 +1,33 @@ +name: Documentation Linting +on: + pull_request: + paths: + - 'docs/**/*.adoc' + - '.github/workflows/vale.yml' + +concurrency: + group: "workflow = ${{ github.workflow }}, ref = ${{ github.event.ref }}, pr = ${{ github.event.pull_request.id }}" + cancel-in-progress: ${{ github.event_name == 'pull_request' || github.repository != 'quarkusio/quarkus' }} + +jobs: + vale: + name: Linting with Vale + runs-on: ubuntu-latest + permissions: + actions: read + checks: read + contents: read + pull-requests: read + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Vale Linter + continue-on-error: true + uses: errata-ai/vale-action@reviewdog + with: + fail_on_error: false + vale_flags: "--no-exit --config=docs/.vale.ini" + filter_mode: diff_context + files: docs/modules/ROOT + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/docs/.vale.ini b/docs/.vale.ini new file mode 100644 index 000000000000..78b9fd6b3e9a --- /dev/null +++ b/docs/.vale.ini @@ -0,0 +1,32 @@ +# Vale configuration file. +# For more information, see: https://docs.errata.ai/vale/config. + +# The relative path to the folder containing linting rules (styles). +StylesPath = ./.vale/styles + +# Minimum alert level +# ------------------- +# The minimum alert level in the output (suggestion, warning, or error). +# If integrated into CI, builds fail by default on error-level alerts, unless you run Vale with the --no-exit flag + +MinAlertLevel = suggestion + +# IgnoredScopes specifies inline-level HTML tags to ignore. +# These tags may occur in an active scope (unlike SkippedScopes, skipped entirely) but their content still will not raise any alerts. +# Default: ignore `code` and `tt`. +IgnoredScopes = code, tt, img, url, a, body.id + +# SkippedScopes specifies block-level HTML tags to ignore. Ignore any content in these scopes. +# Default: ignore `script`, `style`, `pre`, and `figure`. +# For AsciiDoc: by default, listingblock, and literalblock. +SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock + +# Match AsciiDoc files. See: https://docs.errata.ai/vale/scoping +# Ignore files in a directory starting by `.` +# to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files +[[!.]*.adoc] +# Styles to load, located in the `StylesPath` folder: +BasedOnStyles = Quarkus + +# Ignore attributes definition, id statements +TokenIgnores = (:[^\n]+: [^\n]+), (\[id=[^\n]+) diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/.vale.ini b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/.vale.ini new file mode 100644 index 000000000000..c6a3d6be4864 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `CaseSensitiveTerms` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.CaseSensitiveTerms = YES diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/RepeatedWords/.vale.ini b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/RepeatedWords/.vale.ini new file mode 100644 index 000000000000..7ee01b238b4a --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/RepeatedWords/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SentenceLength` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.RepeatedWords = YES \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/RepeatedWords/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/RepeatedWords/testinvalid.adoc new file mode 100644 index 000000000000..8855b0fa4344 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/RepeatedWords/testinvalid.adoc @@ -0,0 +1,2 @@ +This is is a sentence with a repeated word. +This is a test test. diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/RepeatedWords/testvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/RepeatedWords/testvalid.adoc new file mode 100644 index 000000000000..0740ca818c24 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/RepeatedWords/testvalid.adoc @@ -0,0 +1,6 @@ +This is a sentence without a repeated word. +This is a sentence with two instances of a word. +Allow searches to be performed on type, contributor, contributor type, and others. +This is a Text. Text is nice. +This is a text. Text is nice. +Select the THE checkbox. diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/Spacing/.vale.ini b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/Spacing/.vale.ini new file mode 100644 index 000000000000..73fa9667defb --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/Spacing/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Spacing` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.Spacing = YES diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/Spacing/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/Spacing/testinvalid.adoc new file mode 100644 index 000000000000..da4e1ebe5057 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/Spacing/testinvalid.adoc @@ -0,0 +1 @@ +this. That \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/Spacing/testvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/Spacing/testvalid.adoc new file mode 100644 index 000000000000..177df542a14c --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/Spacing/testvalid.adoc @@ -0,0 +1 @@ +this. That \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc new file mode 100644 index 000000000000..cae58431dca6 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc @@ -0,0 +1,270 @@ +assertj +Assertj +Asciidoc +asciidoc +AsciiDoctor +asciidoctor +Bios +btrfs +burner +c group +capex +capEx +Capex +CD 1 +Cds +CDS +CGroup +classic mode +configmap +configuration map +control key +csv +ctrl +cygmon +CygMon +CYGMON +Denial of Service +Denial-of-Service +Dev Mode +Dev mode +Dev Ops +Dev-Ops +devops +Devops +disk druid +Disk druid +diskdruid +dns +DVD burner +Exec Shield +exif +EXIF +F.A.Q +faq +Faq +fedora project +fortran +fqdn +Fqdn +gb +Gb +gbps +GBPS +GDBTK +gid +Gid +gimp +Gimp +git +GIT +gnome +Gnome +gnu +Gnu +gpl +Gpl +Graalvm +graalVM +GRPC +Grub +gtk +Gtk +HP Proliant +hyper-threading +hyperthreading +Hyperviser +HyperVisor +ia64 +IA64 +IBM z Systems +ignition config +Infiniband +Intel Tolapai +Iops +IOPs +Ip +IPSec +iSeries +iso +iso image +Istio Service Mesh +Itanium2 +JBoss.org +jetbrains +Jetbrains +Junit +junit +jvm +Jvm +kernel-based virtual machine +knowledgebase +kickstart +kvm +lan +Lan +linux +LINUX +Microprofile +micro-profile +MicroSoft +mongoDB +Mongo DB +Mongodb +Mongo-db +MS +ms-dos +Ms-Dos +MS-dos +msdos +MSDOS +MSFT +mutual tls +Mutual tls +Mutual TLS +mySQL +MYSQL +node.js +node.JS +Node.JS +nodejs +Nodejs +Objective-C +openid connect +Openid Connect +Open InfiniBand +Operating Environment +Operating System +Operator hub +Operator Hub +operatorhub +Operatorhub +opEx +Opex +Opex +OPEX +OS +P-PC +podman +Pop-up +popup +posix +Posix +Postscript +Powershell +powershell +PPC +PPC64 +ppp +Ppp +prom +Prom +proof key for code exchange +pSeries +q & a +Q & A +q&a +Q&A +qcow2 +Qcow2 +Qeth +QETH +ram +Ram +RAM-disk +ramdisk +RAMdisk +RAW +Red Boot +Red Hat Proxy +Red Hat satellite +Red Hat Satellite server +Red Hat Satellite Capsule server +Red Hat Network Satellite server +Redboot +resteasy +Resteasy +RESTEASY +rom +Rom +rpm +S-E Linux +s-record +s-Record +S-Record +S90 +samba +SAMBA +SE Linux +SE-Linux +selinux +Shadow Man +Shadow passwords +Shadow utilities +ShadowMan +socks +software collection +Software collection +Spring boot +SR IOV +SREC +ssh +Ssh +SSL +Star Office +Staroffice +StartX +SU +Sys V +system d +system D +system D +System V +SystemD +Tolapai +ttl +uid +UltraSparc +ULTRASPARC +unix +unix Socket +UNIX-like +url +var +VI +vim +VIM +Virtual Console +Virtual Desktop Server Management +Virtual Network Interface Card +virtual-console +VisualStudio Code +VisualStudioCode +vlan +vLAN +vnic +VNIC +vnuma +VNUMA +vpn +VS Code +VSCode +VT +VT-i +wan +wca +Webauthn +webAuthn +WebAuthN +Websocket +websocket +web-UI +webUI +Window-Maker +WindowMaker +XDS +Xemacs +Xterm +yaml +Yaml is not a markup language. +Compared to yaml, JSON has way more curly braces. diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc new file mode 100644 index 000000000000..1d106b17eb96 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc @@ -0,0 +1,163 @@ +AssertJ +AsciiDoc +Asciidoctor +/var +BIND +bind +BIOS +Btrfs +CapEx +CD #1 +CDs +cgroup +ConfigMap +CSV +Ctrl +Cygmon +denial of service +denial-of-service +DevOps +dev mode +Disk Druid +DNS +DVD writer +Exec-Shield +Exif +FAQ +Fedora™ Project +Fortran +Fluentd +FQDN +GB +Gbps +GID +GIMP +Git +GNOME +GNOME Classic +GNU +GPL +GraalVM +Gradle +Graylog +gRPC +GRUB +GTK+ +Hibernate ORM +HP ProLiant +Hyper-Threading +hypervisor +IBM eServer System p +IBM S 390 +IBM S 390 +IBM Z +Ignition config +InfiniBand +Insight +Intel Virtualization Technology +Intel(R) EP80579 Integrated Processor +IOPS +IP +IPsec +ISeries +ISO +ISO image +Istio service mesh +Itanium +Itanium 2 +JBoss Community +JBoss Logging +JetBrains +JUnit +JVM +Kernel-based Virtual Machine +Knowledgebase +Kickstart +KVM +LAN +Linux +Logstash +Mandrel +MicroProfile +Microsoft +MongoDB +ms +MS-DOS +mutual TLS +mTLS +MySQL +Node.js +Objective C +OpenID Connect +operating environment +operating system +OperatorHub +OpEx +Podman +pop-up +POSIX +PostScript +PowerPC +PowerShell +PPP +PROM +Prometheus +Proof Key for Code Exchange +Q and A +QCOW2 +qeth +RAM +RAM disk +raw +Red Hat Network Proxy Server +Red Hat Satellite +Red Hat Satellite Server +Red Hat Satellite Capsule Server +Red Hat Network Satellite Server +RedBoot +RESTEasy +ROM +RPM +S-record +Samba +SELinux +shadow passwords +shadow utilities +Shadowman +SOCKS +Software Collection +Spring Boot +SR-IOV +SSH +SSL/TLS +StarOffice +startx +su +systemd +SysV +TTL +UID +UltraSPARC +Unix socket +URL +VAR +VDSM +vi +Vim +virtual console +Visual Studio Code +VLAN +vNIC +vNUMA node +VPN +WAN +WCA +web UI +WebAuthn +WebSocket +Window Maker +xDS +XEmacs +xterm +YAML +File extension example.yaml must pass. \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/ConsciousLanguage/.vale.ini b/docs/.vale/fixtures/Quarkus/ConsciousLanguage/.vale.ini new file mode 100644 index 000000000000..64908cdc298f --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/ConsciousLanguage/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ConsciousLanguage` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.ConsciousLanguage = YES diff --git a/docs/.vale/fixtures/Quarkus/ConsciousLanguage/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/ConsciousLanguage/testinvalid.adoc new file mode 100644 index 000000000000..dc4d18eaea1c --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/ConsciousLanguage/testinvalid.adoc @@ -0,0 +1,4 @@ +blacklist +whitelist +master +slave \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/ConsciousLanguage/testvalid.adoc b/docs/.vale/fixtures/Quarkus/ConsciousLanguage/testvalid.adoc new file mode 100644 index 000000000000..54eaae93d93a --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/ConsciousLanguage/testvalid.adoc @@ -0,0 +1,16 @@ +allowlist +blocklist +primary +source +initiator +requester +controller +host +director +secondary +replica +responder +device +worker +proxy +performer \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/Ellipses/.vale.ini b/docs/.vale/fixtures/Quarkus/Ellipses/.vale.ini new file mode 100644 index 000000000000..29a207fe91fa --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Ellipses/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Ellipses` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.Ellipses = YES diff --git a/docs/.vale/fixtures/Quarkus/Ellipses/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/Ellipses/testinvalid.adoc new file mode 100644 index 000000000000..d0707338739e --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Ellipses/testinvalid.adoc @@ -0,0 +1 @@ +this ... that \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/Ellipses/testvalid.adoc b/docs/.vale/fixtures/Quarkus/Ellipses/testvalid.adoc new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/.vale/fixtures/Quarkus/Fluff/.vale.ini b/docs/.vale/fixtures/Quarkus/Fluff/.vale.ini new file mode 100644 index 000000000000..06beed7edef2 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Fluff/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `fluff` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.Fluff = YES diff --git a/docs/.vale/fixtures/Quarkus/Fluff/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/Fluff/testinvalid.adoc new file mode 100644 index 000000000000..70ca06424374 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Fluff/testinvalid.adoc @@ -0,0 +1,4 @@ +he +host name +I +she \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/Fluff/testvalid.adoc b/docs/.vale/fixtures/Quarkus/Fluff/testvalid.adoc new file mode 100644 index 000000000000..8b2afef3b9d7 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Fluff/testvalid.adoc @@ -0,0 +1 @@ +Do this and this diff --git a/docs/.vale/fixtures/Quarkus/HeadingPunctuation/.vale.ini b/docs/.vale/fixtures/Quarkus/HeadingPunctuation/.vale.ini new file mode 100644 index 000000000000..61bad58c665f --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/HeadingPunctuation/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `HeadingPunctuation` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.HeadingPunctuation = YES diff --git a/docs/.vale/fixtures/Quarkus/HeadingPunctuation/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/HeadingPunctuation/testinvalid.adoc new file mode 100644 index 000000000000..efa1eebe5a20 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/HeadingPunctuation/testinvalid.adoc @@ -0,0 +1 @@ += An invalid heading. diff --git a/docs/.vale/fixtures/Quarkus/HeadingPunctuation/testvalid.adoc b/docs/.vale/fixtures/Quarkus/HeadingPunctuation/testvalid.adoc new file mode 100644 index 000000000000..b5b40cc2b04b --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/HeadingPunctuation/testvalid.adoc @@ -0,0 +1 @@ += A valid heading \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/Headings/.vale.ini b/docs/.vale/fixtures/Quarkus/Headings/.vale.ini new file mode 100644 index 000000000000..0ac376da5ec9 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Headings/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Headings` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.Headings = YES diff --git a/docs/.vale/fixtures/Quarkus/Headings/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/Headings/testinvalid.adoc new file mode 100644 index 000000000000..015a62cc2dce --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Headings/testinvalid.adoc @@ -0,0 +1 @@ += An Invalid Heading \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc b/docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc new file mode 100644 index 000000000000..b1350f5b4c3d --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc @@ -0,0 +1,18 @@ += A valid heading +== GitLab Code Quality +== The Infinispan project +== Installing SmallRye to do xyz +== Installing RESTEasy with Quarkus +== A Jira instance +== Knative is a component used in Quarkus +== Eclipse Vert.x and Netty are upgraded in Quarkus +== IBM Cloud +== Proof Key for Code Exchange +== Kogito updates +== IBM Cloud is a valid product name +== Spotify, GraphQL, and Vineflower are proper nouns so uppercase in headings is OK. +== Use xDS gRPC +== Use JBoss Logging for application logging +== JBoss Logging API +== A heading about Graylog, Logstash, or Fluentd open-source software +== About the Istio service mesh \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/OxfordComma/.vale.ini b/docs/.vale/fixtures/Quarkus/OxfordComma/.vale.ini new file mode 100644 index 000000000000..f9d5351f18a4 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/OxfordComma/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `OxfordComma` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.OxfordComma = YES diff --git a/docs/.vale/fixtures/Quarkus/OxfordComma/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/OxfordComma/testinvalid.adoc new file mode 100644 index 000000000000..371a7242b58a --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/OxfordComma/testinvalid.adoc @@ -0,0 +1 @@ +this, this and that \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/OxfordComma/testvalid.adoc b/docs/.vale/fixtures/Quarkus/OxfordComma/testvalid.adoc new file mode 100644 index 000000000000..fe75d599c0d9 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/OxfordComma/testvalid.adoc @@ -0,0 +1,2 @@ +this, this, and that +this and that \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/RepeatedWords/.vale.ini b/docs/.vale/fixtures/Quarkus/RepeatedWords/.vale.ini new file mode 100644 index 000000000000..e1cea92db570 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/RepeatedWords/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SentenceLength` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.RepeatedWords = YES diff --git a/docs/.vale/fixtures/Quarkus/RepeatedWords/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/RepeatedWords/testinvalid.adoc new file mode 100644 index 000000000000..a660a92c5329 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/RepeatedWords/testinvalid.adoc @@ -0,0 +1 @@ +This is is a sentence with a repeated word. diff --git a/docs/.vale/fixtures/Quarkus/RepeatedWords/testvalid.adoc b/docs/.vale/fixtures/Quarkus/RepeatedWords/testvalid.adoc new file mode 100644 index 000000000000..2819b350515c --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/RepeatedWords/testvalid.adoc @@ -0,0 +1 @@ +This is a sentence with a repeated word. diff --git a/docs/.vale/fixtures/Quarkus/SentenceLength/.vale.ini b/docs/.vale/fixtures/Quarkus/SentenceLength/.vale.ini new file mode 100644 index 000000000000..4ee1c4ae117a --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/SentenceLength/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SentenceLength` rule +StylesPath = ../../../styles +MinAlertLevel = warning +[*.adoc] +Quarkus.SentenceLength = YES diff --git a/docs/.vale/fixtures/Quarkus/SentenceLength/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/SentenceLength/testinvalid.adoc new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/docs/.vale/fixtures/Quarkus/SentenceLength/testvalid.adoc b/docs/.vale/fixtures/Quarkus/SentenceLength/testvalid.adoc new file mode 100644 index 000000000000..8579f6a877b4 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/SentenceLength/testvalid.adoc @@ -0,0 +1 @@ +A sentence less than 32 words. diff --git a/docs/.vale/fixtures/Quarkus/Spacing/.vale.ini b/docs/.vale/fixtures/Quarkus/Spacing/.vale.ini new file mode 100644 index 000000000000..73fa9667defb --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Spacing/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Spacing` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.Spacing = YES diff --git a/docs/.vale/fixtures/Quarkus/Spacing/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/Spacing/testinvalid.adoc new file mode 100644 index 000000000000..da4e1ebe5057 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Spacing/testinvalid.adoc @@ -0,0 +1 @@ +this. That \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/Spacing/testvalid.adoc b/docs/.vale/fixtures/Quarkus/Spacing/testvalid.adoc new file mode 100644 index 000000000000..177df542a14c --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Spacing/testvalid.adoc @@ -0,0 +1 @@ +this. That \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/Spelling/.vale.ini b/docs/.vale/fixtures/Quarkus/Spelling/.vale.ini new file mode 100644 index 000000000000..fd6c76ec8fc3 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Spelling/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Spelling` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.Spelling = YES diff --git a/docs/.vale/fixtures/Quarkus/Spelling/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/Spelling/testinvalid.adoc new file mode 100644 index 000000000000..a8c28b746876 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Spelling/testinvalid.adoc @@ -0,0 +1,62 @@ +ansible +antora +api +bitbucket +btrfs +centos +Centos +ceph +Classloader +crd +ctrl +Daemonset +dns +dotnet +endevor +gluster +Graal VM +graal vm +gui +homebrew +Ide +intelephense +infinispan +Intellij +Intellij IDEA +lombok +jetbrains +Jvm +kibana +kubespray +lombok +mattermost +microsoft azure +mokitto +mokito +minikube +Mysql +mysql +Netcoredebugoutput +nginx +Nuget +Oauth +Omnisharp +Openshift +Opentracing +php +Postgresql +postgres +podman +quarkus +restic +Sbt +scm +svg +symfony +uber +uri +velero +webview +webviews +woopra +zowe diff --git a/docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc b/docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc new file mode 100644 index 000000000000..996028692722 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc @@ -0,0 +1,390 @@ +a .NET application +accessor +adoc +Agroal +Allowlist +allowlist +Annobin +Ansible +Antora +API +AssertJ +autostart +Autostart +aws +AWS +Azure +backfilling +Backfilling +backtrace +backported +Backtrace +Bierner +bindable +Bindable +Bitbucket +BOM +Bonjour +boolean +Boolean +Bouncy Castle +breakpoint +Breakpoint +breakpoints +Breakpoints +btn +Btrfs +Bugzilla +build config +CentOS +Ceph +cephfs +cgroup +che +Che +Che-Theia +Ciphertext +Civetweb +ClassLoader +classpath +classloading +Classloading +Cloudbursting +Cloudwashing +CodeReady +colocate +Colocate +config +Config +ConfigMap +ConfigMaps +config map +config maps +configure +Containerfile +Containerfiles +Cookiecutter +CR +CRD +CRDs +CRs +CSVs +Ctrl +customizer +Cygmon +datasource +datasources +DaemonSet +Datadog +declaratively +decompiler +deserialization +deserialized +Dev +dev +devfile +Devfile +devfiles +Devfiles +devworkspace +DevWorkspace +DevWorkspace +Dex +DNS +Docker +Dockerfile +Dockerfiles +Dotnet +downstream +Downstream +downstreaming +Downstreaming +Dyninst +Endevor +Endian +endif +Esprima +Exif +exposal +Exposal +Fabrice +factories +Factories +factory +Factory +failback +Failback +failover +Failover +Failsafe +Fernflower +findability +Findability +Fluentd +Fortran +Funqy +Gbps +Graylog +gRPC +GCC +getters +Git +GitHub +GitLab +Gluster +GraalVM +Gradle +Grafana +GraphQL +Grayscale +GUI +hardcoding +Hashicorp +Heatmap +Helgrind +Helm +Homebrew +hostname +Hostname +htmltest +http +HTTP +https +HTTPS +Hyperconverged +I/O +IDE +IDEs +Infinispan +Inode +Intelephense +IntelliJ +Istio +Itanium +Item +Jakarta +Jandex +Java +Jave +JBoss +JetBrains +Jira +Jolokia +Journald +Journaling +Joyent +JUnit +jvm +JVM +Kafka +kbd +Keycloak +Keylime +Keyring +Keyrings +Kibana +Knative +Knowledgebase +Kogito +Kompose +Kubespray +Kylin +Laravel +Let's Encrypt +libvirt +Libvirt +Licensor +Liveness +Logstash +Lombok +Loopback +Makefile +Matrixes +Mattermost +Maven +Mebibytes +metamodel +MicroProfile +Microsoft +Middleware +middleware +Millicores +Minikube +Minishift +Mirantis +Mixin +Mixins +Modularization +Mockito +MongoDB +Multicluster +Multihost +Multinode +Multitenant +multithread +Multithread +Multiuser +Multizone +MySQL +Nagios +Namespace +Namespaces +Narayana +Neoverse +NetcoredebugOutput +Netty +Newdoc +Nginx +Node.js +npm +NuGet +OAuth +ocp +OmniSharp +Onboarding +OpenID +OpenJDK +OpenShift +OpenTracing +Operator +osd +OTel +overridable +PHP +Podman +PostgreSQL +PowerShell +preconfigured +Preconfigured +pregenerated +prepended +preconfigured +prepend +prepended +productize +productized +Prometheus +proxied +Pulldown +Pytorch +qeth +Quarkiverse +Quarkus +Qute +Readonly +Rebalance +Rebalances +Rebalancing +Rebase +Rebased +Recertification +Recertifications +Redistributions +Reshard +Resharding +Reshards +RESTEasy +Restic +Resyncing +Rolfe +Rollout +Rollouts +Roundtable +Roundtables +ruleset +Runlevel +Runlevels +Runtime +Runtimes +Sakila +sbt +SCM +Scrollbar +searchability +Searchability +SELinux +Semeru +serialization +serializable +Serializer +Serverless +servlet +setters +Shadowman +Sharding +SLA +SLAs +SmallRye +Spotify +startx +su +Subcommand +Subcommands +Submenu +Submenus +Subnetwork +Subnetworks +Subpackage +Subpackages +Subpath +Subpaths +Substep +Substeps +Subtest +Subtests +Subuser +Subusers +Subvolume +Subvolumes +Suchow +Syslog +syslog +Symfony +SVG +Systemd +Tekton +Telekom +Templated +Tensorflow +Texinfo +Theia +Tolerations +Toolset +traceback +Traceback +Traefik +trivial +Truststore +Uber +Uncomment +Undercloud +Uninstallation +Unmount +Unmounting +Unported +Unstaged +Untrusted +Upsell +Upselling +URI +URIs +url +URL +URLs +Valgrind +validator +Velero +Vert.x +Vineflower +vsix +WebAuthn +WebSocket +Webview +Webviews +Wildfly +Woopra +Wordpress +YAML +Yana +Yeoman +Zowe diff --git a/docs/.vale/fixtures/Quarkus/TermsErrors/.vale.ini b/docs/.vale/fixtures/Quarkus/TermsErrors/.vale.ini new file mode 100644 index 000000000000..69b03d337f13 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/TermsErrors/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `TermsErrors` rule +StylesPath = ../../../styles +MinAlertLevel = warning +[*.adoc] +Quarkus.TermsErrors = YES diff --git a/docs/.vale/fixtures/Quarkus/TermsErrors/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/TermsErrors/testinvalid.adoc new file mode 100644 index 000000000000..4c686d253d14 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/TermsErrors/testinvalid.adoc @@ -0,0 +1,391 @@ +64-bit x86 +a lot +a lot of +a number of +a phone +a S 390 +a transition +abort +administrate +advisor +air wall +all caps +all right +alright +analyse +and/or +as long as +as per +autodetect +back-level +backward-compatible +bi-monthly +bi-weekly +Big Blue +blink +blue screen of death +boot diskette +bootloader +bottle neck +bottle-neck" +bottom-left +bottom-right +bottomleft +bottomright +breadcrumbing +broad cast +broad-cast" +bugfix +built in +builtin +bunches of +burner +canned +case insensitive +catastrophic error +CBE +CBTS +CD burner +centre +chip specific +cipher text +cipher-text +clear text +cleartext +cloud-bursting +cloud-washing +co-locate +cold backup +cold boot +cold start +collocate +colour +comes with +comma delimited +comma delimited values +comma separated values +comma-delimited values +commadelimited +command driven +command prompt +command-language +commanddriven +componentization +componentize +comprised of +computer farm +computer ranch +connect with +container based +containerised +context menu +contextual help +control-click +crash +cross platform +cross site scripting +crossplatform +CRUD +Ctrl-click +cypher text +cypher-text +cyphertext +daisy-chain +daisychain +data centre +data-center +data-mirroring +datacenter +datacentre +datamirroring +datapath +datum +de-bug +debuggable +deconfigure +deinstall +deinstallation +demilitarized zone +demo +demon +depress +deregister +desire +desk top +desk-top +destroy +dev +different than +different to +disk-label +disklabel +dismount +domain-name +domainname +down load +down stream +down-level +down-load +down-stream +downgrade +downward compatible +drag and drop +drill up +dual boot +dualboot +e-fix +e.g. +eFix +eg +emphasise +end user +end-user interface +entitlement +env +etc. +EUI +fill in +finalise +Firefox +firm ware +firm-ware +fixed disk drive +flavor +floating-point +floppy +floppy disk +floppy drive +focussed +fore-ground +forground +forward compatible +gray scale +gray-scale +gzip +gzipped +Hammer +hard drive +hard file +hardcode +hardcoded +health-check +healthcheck +help-desk +helpdesk +hence +hostgroup +hot-add +hot-line +hot-plug +hot-swap +hotadd +hotplug +hotswap +hyper-converged +i-fix +i-Fix +i.e. +IBM's +ie +ifix +iFix +in order to +in other words +in spite of +in the event +inactivate +information on +information technology +instead of +insure +Internet address +irrecoverable +jar +keep in mind +kernelspace +knowledgebase +labour +laptop +large page +launch +learnt +leave out +left-hand +leverage +line cord +Linux specific +look at +lots of +main directory +make sure +manpage +mash up +mashup +matrices +memory stick +menu driven +menudriven +microcomputer +motherboard +mouse over +mouse-button +mousebutton +multi-processing +multi-tenant +network-centric computing +non-English +non-secure +nonrecoverable +nonsecure +notion +off-premise +offline storage +OK button +okay +on ramp +on the fly +on the other hand +on-premise +on-ramp +oops +op-code +open-source +opensource +OpenSource +organise +organised +organising +over ride +over-ride +pain point +parent task +perfcounter +perimeter network +phone +plain-text +plaintext +plugin +plugins +plug in +plug ins +pop-up blocker +pop-up killer +power down +power off +power on +preload +preloaded +prepend +proof of concepts +pseudo ops +pseudoops +pull-down +re-occur +recognise +remote-access +remote-access server +reoccur +repo +right double-click +right now +right-hand +round table +rule of thumb +run level +run-level +S 390 +sanity check +screensaver +scroll bar +scroll-bar +secondary storage +selection button +send out +serial database +sharename +Sharename +shift-click +ship +Simple Object Access Protocol +single quote +single quote mark +SME routine +sort-merge +sort/merge +sound-card +soundcard +specfile +spelt +stand-alone +start up +straight forward +straight-forward +sub-command +sub-directory +sub-menu +sub-package +sunset +super page +super user +super-user +swapspace +switch off +switch on +tarball +terminate +text based +text-mode +textmode +the installer +the transition +thin provisioned +thinly provisioned +thinly-provisioned +thumbstick +Thunderbird +thus +tier 1 +tier-one +time-frame +timeframe +toggle off +tooling +top-left +top-right +topleft +topright +touchscreen +transition +typo +uncheck +uncompress +undeploy +unjar +unselect +untar +unzip +up grade +up selling +up stream +up time +up-grade +up-sell +up-selling +up-stream +up-time +upward compatible +utilize +versus +via +video-mode +videomode +virtualized +vs. +warning notice +web-enable +wish +would like +x64 +x86_64 +x86-64 +zero out diff --git a/docs/.vale/fixtures/Quarkus/TermsErrors/testvalid.adoc b/docs/.vale/fixtures/Quarkus/TermsErrors/testvalid.adoc new file mode 100644 index 000000000000..8844481f1e81 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/TermsErrors/testvalid.adoc @@ -0,0 +1,341 @@ +a or b +a, b, or both +access method +according to +add a prefix to +administer +air gap +alternatively +AMD64 +and so on +app +archive +as +as expected +as in +as needed +attention notice +auto-detect +auxiliary storage +bimonthly +biweekly +boot disk +boot loader +bottleneck +breadcrumb trail +broadcast +BTS +bug fix +built-in +cancel +CD writer +cell phone +cell phone +challenge +change +CICS BTS +ciphertext +clear +cloudbursting +cloudwashing +colocate +comma-delimited +comma-separated values +command language +command-driven +Common Base Event +compared to +compatible with earlier versions +compatible with later versions +complete +component architecture +component model +component-based development +compress +compressed file +concept +concern +connect to +consist of +container-based +containerized +context-sensitive help +conversely +correct +create +create retrieve update and delete +cross-platform +cross-site scripting +daemon +daisy chain +data +data center +data mirroring +data path +deactivate +debug +decompress +delete from the database +demonstration +demount +deselect +desktop +despite +dev mode +develop components +different from +difficulty +discontinue +disk label +diskette +diskette drive +DMZ +domain name +double right-click +download +downstream +drag +dual-boot +dynamically +earlier +emit +enable for the web +end +ensure +enter +environment +evaluate +examine +extract +fail +fall back +fallback +firmware +fix +flash +floating point +for example +foreground +graphical interface +graphical user interface +grayscale +hard code +hard disk +hard disk drive +hard-coded +hardware restart +health check +help +help desk +host group +hot add +hot plug +hot swap +hotline +however +huge page +hyperconverged +IBM +IBM S 390 +if +immediately +in case +in languages other than English +in real time +include +included +includes +information about +insecure +installation program +interface +interim fix +Internet email address +IP address +issue +IT +kernel oops +kernel-space +knowledge base +left +left mouse button +lock up +lower left +lower right +lower-left +lower-right +make the transition +make the transition +man page +many +matrixes +menu +menu-driven +merge +method +migrate +mobile phone +mobile phone +Mouse +mouse button +move +move the mouse pointer over +Mozilla Firefox +Mozilla Thunderbird +ms +much +multiprocessing +multitenant +navigate +need +network computing +no longer support +non-English-language +nonpartitioned database environment +not at the latest level +not case-sensitive +notebook +now +off-premises +offline backup +offsite +OK +omit +on-premises +onsite +opcode +open +open source +override +parent process +PC +performance counter +plain text +plug-in +plug-ins +point to +pop-up menu +power cable +power cord +preconfigured +predefined +preinstall +preinstalled +preplanned +press +press Ctrl and click +press Shift and click +previous +proofs of concept +provided that +pseudo-ops +pulldown +rather than +recur +regardless of +remember +remote access +remote access server +remove +repository +required +retry +right +roll back +rollback +root directory +roundtable +rule +runlevel +screen saver +scrollbar +server farm +session management exit routine +several +share name +shared components +shell prompt +shell script +single quotation mark +SOAP +software to block pop-up ad windows +sort +sound card +spec file +specific +specify +spelled +standalone +start +stop +stop error +stop responding +straightforward +subcommand +subdirectory +submenu +subpackage +subscription +superuser +swap space +system board +tar file +telephone +test +text mode +text-based +that is +therefore +thin-provisioned +this clause that is restrictive +this clause, which is nonrestrictive +through +tier-1 +time frame +to +toggle +tools +touch-sensitive screen +try again +turn off +turn on +type +typing error +typographical error +unconfigure +uninstall +uninstallation +unmount +unrecoverable +unrecoverable error +unregister +upgrade +upper left +upper right +upper-left +upper-right +uppercase +upsell +upselling +upstream +uptime +URL +USB flash drive +use +user +verify +version +video mode +virtual +want +web address +web seminar +web-based event +webcast +webinar +when +withdraw +withdraw from marketing +withdraw from service +zero +zip diff --git a/docs/.vale/fixtures/Quarkus/TermsSuggestions/.vale.ini b/docs/.vale/fixtures/Quarkus/TermsSuggestions/.vale.ini new file mode 100644 index 000000000000..1362bfc95a77 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/TermsSuggestions/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `TermsSuggestions` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.TermsSuggestions = YES diff --git a/docs/.vale/fixtures/Quarkus/TermsSuggestions/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/TermsSuggestions/testinvalid.adoc new file mode 100644 index 000000000000..7464c0532dcb --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/TermsSuggestions/testinvalid.adoc @@ -0,0 +1,35 @@ +and so on +bare metal +bare-metal +between +bps +Bps +cd +CD +channel +client side +client-side +Cloud +code +functionality +input +recommend +refer to +roll out +roll-out +rollout +segfault +shell +Start using this. +tar +this clause, that is restrictive +this clause which is nonrestrictive +through +thru +type +user space +user-space +userspace +zip +Navigate +navigate diff --git a/docs/.vale/fixtures/Quarkus/TermsSuggestions/testvalid.adoc b/docs/.vale/fixtures/Quarkus/TermsSuggestions/testvalid.adoc new file mode 100644 index 000000000000..32971eb1aaf0 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/TermsSuggestions/testvalid.adoc @@ -0,0 +1,15 @@ +archive +cloud +compress +enter +functions +repository +see +segmentation fault +shell prompt +shell script +Start by using this. +such as +write +this clause that is restrictive +this clause, which is nonrestrictive \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/TermsWarnings/.vale.ini b/docs/.vale/fixtures/Quarkus/TermsWarnings/.vale.ini new file mode 100644 index 000000000000..56edd3afba20 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/TermsWarnings/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `TermsWarnings` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +Quarkus.TermsWarnings = YES diff --git a/docs/.vale/fixtures/Quarkus/TermsWarnings/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/TermsWarnings/testinvalid.adoc new file mode 100644 index 000000000000..70ca06424374 --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/TermsWarnings/testinvalid.adoc @@ -0,0 +1,4 @@ +he +host name +I +she \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/TermsWarnings/testvalid.adoc b/docs/.vale/fixtures/Quarkus/TermsWarnings/testvalid.adoc new file mode 100644 index 000000000000..87f357e8e98b --- /dev/null +++ b/docs/.vale/fixtures/Quarkus/TermsWarnings/testvalid.adoc @@ -0,0 +1,5 @@ +host +hostname +I/O +name +you \ No newline at end of file diff --git a/docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml b/docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml new file mode 100644 index 000000000000..a6479e1f60a7 --- /dev/null +++ b/docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml @@ -0,0 +1,314 @@ +--- +extends: substitution +ignorecase: false +level: suggestion +link: https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/doc-reference.adoc +message: Use '%s' rather than '%s'. +# source: Quarkus contributor guide +action: + name: replace +swap: + "(?=2.20.0" +}