diff --git a/.gitignore b/.gitignore index e86e7e3..9e0334d 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ build cache public *~ +.vale/styles/RedHat/ diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 0000000..08744a0 --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1 @@ +.vale diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000..b59d4da --- /dev/null +++ b/.vale.ini @@ -0,0 +1,40 @@ +StylesPath = .vale/styles + +MinAlertLevel = error + +IgnoredScopes = code, tt, img, url, a, body.id + +SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock + +Packages = RedHat + +# Match AsciiDoc files. See: https://vale.sh/docs/topics/scoping/ +# Ignore files in a directory starting by `.` +# to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files +[[!.]*.adoc] + +BasedOnStyles = RedHat + +[*.md] + +BasedOnStyles = RedHat + +# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. +TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) + +# Match INI files. See: https://vale.sh/docs/topics/scoping/ +[*.ini] + +BasedOnStyles = RedHat + +# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. +TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) + +# Disabling rules (NO) +RedHat.CaseSensitiveTerms = NO +RedHat.ConfigMap = NO +RedHat.Definitions = NO +RedHat.Slash = NO +RedHat.Spacing = NO +RedHat.Spelling = NO +RedHat.TermsSuggestions = NO diff --git a/.vale/styles/config/vocabularies/ELN/accept.txt b/.vale/styles/config/vocabularies/ELN/accept.txt new file mode 100644 index 0000000..9fa765c --- /dev/null +++ b/.vale/styles/config/vocabularies/ELN/accept.txt @@ -0,0 +1,29 @@ +btrfs +buildroot +centos +deliverables +eln +EPEL +ELN +ELN Extras +rhel +RHEL +CentOS +unbundle +downstreams +freeipa +libreoffice +openssl +libreport +gpsd +subpackage +cron +Koji +enablement +retagging +conditionalized +subpackages +unshipped +workgroup +distro +FESCo diff --git a/README.md b/README.md index ab5fa21..61a9b86 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ It is published via Fedora Docs: 6. **Images** to be used on any page. 7. **Downloadable attachments** to be used on any page. 8. **Menu definition.** Also defines the hierarchy of all the pages. -9. **Pages with the actual content.** They can be also organised into subdirectories if desired. +9. **Pages with the actual content.** They can be also organized into subdirectories if desired. ## Local preview diff --git a/modules/ROOT/pages/eln-branch.adoc b/modules/ROOT/pages/eln-branch.adoc index c8af544..2309161 100644 --- a/modules/ROOT/pages/eln-branch.adoc +++ b/modules/ROOT/pages/eln-branch.adoc @@ -1,7 +1,7 @@ = ELN Branches Whenever possible, ELN work should be done in the Fedora rawhide branches. -But sometimes ELN work needs to be done in an Fedora eln branch. Here are +But sometimes ELN work needs to be done in an Fedora eln branch. Here are the steps for making that happen. == Step 1: Request Permission @@ -62,7 +62,7 @@ as a co-maintaine through https://src.fedoraproject.org/rpms//adduser == Step 3: Maintain Branch After your branch has been created, remember that the ELN branch is your -responsibility. Do not create the branch, build it once, and then never +responsibility. Do not create the branch, build it once, and then never touch the branch again. *If you decide that you no longer need the ELN branch Do not retire the branch. diff --git a/modules/ROOT/pages/eln-macros.adoc b/modules/ROOT/pages/eln-macros.adoc index 0af7215..58e446a 100644 --- a/modules/ROOT/pages/eln-macros.adoc +++ b/modules/ROOT/pages/eln-macros.adoc @@ -1,7 +1,7 @@ = ELN Macros The ELN buildroot defines the %\{rhel\} macro as the next major version of RHEL -(currently, 11), and does not define the %\{fedora\} macro. For almost all cases, +(currently, 11), and does not define the %\{fedora\} macro. For almost all cases, this is sufficient for differentiating build behavior between Fedora and ELN. == Request Permission diff --git a/modules/ROOT/pages/extras.adoc b/modules/ROOT/pages/extras.adoc index 00be3ac..9480061 100644 --- a/modules/ROOT/pages/extras.adoc +++ b/modules/ROOT/pages/extras.adoc @@ -10,7 +10,7 @@ and quicker to get a compose of EPEL N+1 out the door if the initial packages have already been built for ELN-Extras. NOTE: **You** are responsible when your package fails to build on ELN -Extras. Remember to check your packages on +Extras. Remember to check your packages on https://sgallagh.fedorapeople.org/dbs_status.html[the ELN Status Page]. ELN Extras packages get rebuilt much more frequently than in EPEL. @@ -44,7 +44,7 @@ https://github.com/minimization/content-resolver/blob/master/config_specs/worklo The create your initial workload yaml file, take that example yaml file, rename it, edit it, then submit it as a pull request. -The example workload yaml has an example for everything. But we don't need everything +The example workload yaml has an example for everything. But we don't need everything for ELN Extras. ==== Workload Required Sections @@ -105,7 +105,7 @@ Can I add any or all Fedora packages to ELN-Extras?:: You are attaching your name as the supporter of these packages. You will be submitting these workload packages as pull requests. The ELN SIG will review the pull requests and ask questions if - things look strange or incorrect. So, yes, if you are willing + things look strange or incorrect. So, yes, if you are willing to support a package, it can be any Fedora package not in ELN. And while we are not putting a firm limit on the number of packages you can add to ELN Extras, the SIG is reviewing them and will @@ -113,7 +113,7 @@ Can I add any or all Fedora packages to ELN-Extras?:: If someone has already added a package to their workload, can I have the same package in mine?:: -Yes. Content Resolver is setup to deal with a package in more than -one workload, or a dependency in more than one workload. It will show what -workloads list, or require what packages. It even takes a guess on who +Yes. Content Resolver is setup to deal with a package in more than +one workload, or a dependency in more than one workload. It will show what +workloads list, or require what packages. It even takes a guess on who should be the owner of the package. diff --git a/modules/ROOT/pages/faq.adoc b/modules/ROOT/pages/faq.adoc index a017b99..6bea75d 100644 --- a/modules/ROOT/pages/faq.adoc +++ b/modules/ROOT/pages/faq.adoc @@ -21,7 +21,7 @@ image::ROOT:fedora-eln-centos-stream-rhel.png[] What are the differences between Rawhide and ELN?:: For the majority of packages, there is little or no difference between Rawhide and - ELN packages. They are the same versions, usually built on the same libraries. But + ELN packages. They are the same versions, usually built on the same libraries. But there are some https://docs.fedoraproject.org/en-US/eln/buildroot/[buildroot differences] in https://docs.fedoraproject.org/en-US/eln/buildroot/#_compiler_flags_and_other_tweaks[compiler flags] and https://docs.fedoraproject.org/en-US/eln/buildroot/#_distribution_related_macro_definitions[global macros] @@ -49,10 +49,10 @@ What are the differences between the Rawhide and ELN kernel?:: a much larger range of hardware and features. A notable difference is that the ELN kernel does not support btrfs at all, making it difficult to install and use on systems that were installed as Fedora Workstation edition, or in Fedora 35 or newer Cloud images which use btrfs - by default. There are also differences in baseline supported hardware, meaning the ELN kernel + by default. There are also differences in baseline supported hardware, meaning the ELN kernel may not run on older systems where the Rawhide kernel runs just fine. When should I use the rpm macro %\{eln}?:: - Never. In nearly all cases, you actually want to use the %\{rhel} macro. + Never. In nearly all cases, you actually want to use the %\{rhel} macro. See xref:eln-macros.adoc[ELN Macros] for more information. diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index ccc8d49..ce4563e 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -78,7 +78,7 @@ This includes: Who benefits from the ELN project: * Fedora Infrastructure -** As we are going to try and test new infrastructure for composes. +** As we are going to try to test new infrastructure for composes. * Fedora Minimization ** As we are going to modify the compose content according to minimization goals.