Add doc on workspaces

[misterpantz]

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]

Starting creation of the PREview environment...

[github-actions]

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

[github-actions]

PREview has been updated at https://mondoo-pre-docs-2956472595.storage.googleapis.com/docs/index.html

[github-actions]

@check-spelling-bot Report

🔴 Please review

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

Unrecognized words (1)

BAZ

These words are not needed and should be removed

VNic

Some files were automatically ignored 🙈

These sample patterns would exclude them:

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

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, update file exclusions, and remove the previously acknowledged and now absent words, you could run the following commands

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

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.24/apply.pl' |
perl - 'https://github.com/mondoohq/docs/actions/runs/12451149658/attempts/1'

Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

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

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

Consider adding them (in .github/workflows/spell-check.yaml) in jobs:/spelling: for uses: check-spelling/[email protected] in its with:

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

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

check_extra_dictionaries: ''

Forbidden patterns 🙅 (1)

In order to address this, you could change the content to not match the forbidden patterns (comments before forbidden patterns may help explain why they're forbidden), add patterns for acceptable instances, or adjust the forbidden patterns themselves.

These forbidden patterns matched content:

Reject duplicate words

\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s

Errors (2)

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

❌ Errors	Count
⚠️ binary-file	1
❌ forbidden-pattern	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]

PREview has been updated at https://mondoo-pre-docs-2956472595.storage.googleapis.com/docs/index.html