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

Use the single authors.yml file #301

Merged
merged 2 commits into from
Aug 9, 2024
Merged

Use the single authors.yml file #301

merged 2 commits into from
Aug 9, 2024

Conversation

tas50
Copy link
Member

@tas50 tas50 commented Aug 9, 2024

Description

This makes things easier to update in the future and avoids warnings with docusaurus 3.5

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.

Copy link
Contributor

github-actions bot commented Aug 9, 2024

Starting creation of the PREview environment...

Copy link
Contributor

github-actions bot commented Aug 9, 2024

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

@tas50 tas50 force-pushed the tas50/update branch 3 times, most recently from 978f3bb to c88af25 Compare August 9, 2024 17:38
This makes things easier to update in the future and avoids warnings
with docusaurus 3.5

Signed-off-by: Tim Smith <[email protected]>
releases/authors.yml Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented Aug 9, 2024

1 similar comment
Copy link
Contributor

github-actions bot commented Aug 9, 2024

Copy link
Contributor

github-actions bot commented Aug 9, 2024

@check-spelling-bot Report

🔴 Please review

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

Unrecognized words (1)

kyleen

Previously acknowledged words that are now absent ccl 🫥
To accept these unrecognized words as correct 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/update branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/mondoohq/docs/actions/runs/10323415139/attempts/1'
Available 📚 dictionaries could cover words (expected and unrecognized) not in the 📘 dictionary

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

Dictionary Entries Covers Uniquely
cspell:node/dict/node.txt 891 7 3
cspell:java/src/java.txt 2464 4 2
cspell:php/dict/php.txt 1689 4
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) for uses: check-spelling/[email protected] in its with:

      with:
        extra_dictionaries:
          cspell:node/dict/node.txt
          cspell:java/src/java.txt
          cspell:php/dict/php.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: ''
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

github-actions bot commented Aug 9, 2024

Copy link
Contributor

@misterpantz misterpantz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@misterpantz misterpantz merged commit 7ef4d53 into main Aug 9, 2024
5 checks passed
@misterpantz misterpantz deleted the tas50/update branch August 9, 2024 17:50
@github-actions github-actions bot locked and limited conversation to collaborators Aug 9, 2024
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.

2 participants