Merge pull request 'Add sentence case Vale CI' (!215) from brettweir/user-documentation:vale-ci into main

Reviewed-on: server/user-documentation#215
This commit is contained in:
Brett Weir 2026-08-06 06:37:21 +00:00
commit 98e5dc93ba
4 changed files with 19 additions and 5 deletions

View file

@ -0,0 +1,12 @@
on: [push]
jobs:
vale:
runs-on:
- podman
container:
image: docker.io/jdkato/vale
steps:
- uses: actions/checkout@v7
- run: vale .

View file

@ -1,6 +1,6 @@
# Based on RedHat.Headings
extends: capitalization
level: suggestion
level: error
link: https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#headings
match: $sentence
message: "Use sentence-style capitalization in '%s'."
@ -31,6 +31,7 @@ exceptions:
- Fedora Server
- Fedora Server Documentation
- Fedora Server Edition
- Fedora Server Edition User Documentation
- FQDN
- FTP
- GNU
@ -60,6 +61,7 @@ exceptions:
- OpenVZ
- OS
- PKCS#11
- Podman
- POP
- Proxmox
- Proxmov Virtual Environment

View file

@ -70,7 +70,7 @@ Someone will see your pull request and either merge it, or provide feedback if t
10. **Pages with the actual content.** They are organized into subdirectories for specific area of information.
11. Snippets of adoc files reusable in various documentations, organized into subdirectories for specific area of information.
## Components and Modules
## Components and modules
Antora introduces two new terms:

View file

@ -1,10 +1,10 @@
# Documentation Style Guidelines
# Documentation style guidelines
Fedora Server documentation follows the style guidelines defined at https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/style-guide/
Additionally the following general style decisions have been agreed for Fedora Server documentation:
## File Edit Instructions
## File edit instructions
In general, avoid mentioning the editor or including the editor in a codeblock. Describe the filepath in the text preceding the file content and then
include the file content in a codeblock. For example:
@ -32,7 +32,7 @@ EOF
TIP: By quoting the 'EOF' in the command, you can avoid bash variable expansion if the file contains variable strings. Read more on HEREDOC at [The Linux Documentation Project](https://tldp.org/LDP/abs/html/here-docs.html).
## Codeblocks and Command Syntax
## Codeblocks and command syntax
When commands, filepaths or functions are referenced in inline text, enclose them within backticks (`). For example: