Add a Vale rule to report usage of downstream branded terms

[aneta-petrova]

What changes are you introducing?

• Introducing a Vale rule to check for downstream branded terminology and suggest an attribute as a replacement
• Dropping the related table from the contributing guidelines

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

To automate the reviews of these errors and to make the contributing guidelines a little bit shorter.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

The rule reports only downstream terms by design. In some cases, using "Foreman" is actually appropriate. Additionally, most of the cases I've seen as a reviewer were about PR authors (myself included) accidentally using "Satellite", which is what the rule is designed to report.

When running the check on the whole repo, the rule currently reports a few cases of "Satellite" being used, for example

foreman-documentation/guides/common/modules/proc_migrating-a-host-from-red-hat-network.adoc

Line 4 in 92fbccf

= Migrating a host from Red Hat Network (RHN) or Satellite 5 to {Project}

. I don't think this is a problem.

Contributor checklists

• I am okay with my commits getting squashed when you merge this PR.
• I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

• Foreman 3.17/Katello 4.19
• Foreman 3.16/Katello 4.18 (Satellite 6.18)
• Foreman 3.15/Katello 4.17
• Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4)
• Foreman 3.13/Katello 4.15 (EL9 only)
• Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
• Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9; orcharhino 7.1 with Leapp)
• Foreman 3.10/Katello 4.12
• Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
• We do not accept PRs for Foreman older than 3.9.

Summary by Sourcery

Enforce use of AsciiDoc attributes instead of branded downstream terms by adding a Vale substitution rule and simplifying the contributing guidelines to remove the detailed terminology table.

New Features:

• Add a Vale rule to report downstream branded terms and suggest corresponding AsciiDoc attribute replacements

Documentation:

• Remove the detailed branded terminology table from CONTRIBUTING.md and reference the {Project} attribute instead

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR automates enforcement of downstream branded terminology by adding a Vale substitution rule and streamlines the contributing guide by removing the branded-terms table in favor of a single attribute reference.

File-Level Changes

Change	Details	Files
Introduce a Vale rule to detect and replace downstream branded terms	Add a new substitution-based rule under .vale/styles Set error level with a replacement message Define regex-to-attribute swap mappings for branded terms	.vale/styles/foreman-documentation/AvoidBrandedTerminology.yml
Remove branded terminology table from contributing guidelines	Delete the multi-column table listing attribute mappings Update example text to reference only the {Project} attribute	CONTRIBUTING.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[github-actions]

The PR preview for 93297cb is available at theforeman-foreman-documentation-preview-pr-4472.surge.sh

No diff compared to the current base

show diff

[maximiliankolb]

That's a great idea! I don't know how to run this locally yet, but I assume that you've tested it and it works.

When running the check on the whole repo, the rule currently reports a few cases...

This is OK for me because we do not enforce a green Vale check yet. If we did, we might have to extend this rule, add some exceptions, and fix the issues. Not a blocker in my eyes.

Thanks Anet!