Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Add release notes for 11.36 #513

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

WIP: Add release notes for 11.36 #513

wants to merge 1 commit into from

Conversation

tas50
Copy link
Member

@tas50 tas50 commented Dec 23, 2024

Description

After a few weeks off this is the next release

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.

@tas50 tas50 changed the title Add release notes for 11.36 WIP: Add release notes for 11.36 Dec 23, 2024
Copy link
Contributor

Starting creation of the PREview environment...

Copy link
Contributor

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

This comment has been minimized.

Copy link
Contributor

1 similar comment
Copy link
Contributor

This comment has been minimized.

Copy link
Contributor

This comment has been minimized.

Copy link
Contributor

This comment has been minimized.

Copy link
Contributor

This comment has been minimized.

Copy link
Contributor

This comment has been minimized.

Copy link
Contributor

This comment has been minimized.

Copy link
Contributor

This comment has been minimized.

Copy link
Contributor

After a few weeks off this is the next release

Signed-off-by: Tim Smith <[email protected]>
Copy link
Contributor

@check-spelling-bot Report

🔴 Please review

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

Unrecognized words (2)

BAZ
DEETS

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 tas50/11.36 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/12508425898/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 (2)

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:

s.b. GitHub

\bGithub\b
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.

Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant