Skip to content

Commit

Permalink
Initial Commit
Browse files Browse the repository at this point in the history
Signed-off-by: Ben Rockwood <[email protected]>
  • Loading branch information
benr committed Feb 29, 2024
1 parent 774253c commit add2624
Show file tree
Hide file tree
Showing 2,013 changed files with 77,829 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### mondoohq/docs CODEOWNERS

# Markdown updates should be reviewed by an editor
*.md @mondoohq/mondoo-editors
*.mdx @mondoohq/mondoo-editors
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/content-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Content issue
about: Info in the docs is incorrect, missing, or problematic
title: ""
labels: ""
assignees: ""
---

#### Summarize the content issue

For example, write "Can't find info on xxx " or "Required permissions for Azure scan are out of date."

#### URL(s)

Provide the URL(s) for the page(s) where the issue exists.

#### What the docs say

If there's existing, incorrect content, paste it here.

#### What the docs SHOULD say

Provide the correct info here (if you know it).

#### Screenshots

If applicable, add screenshots to demonstrate the problem.

#### References

If applicable, provide links to relevant sources of info.

#### Notes

Add any other info you want to provide.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/functional-bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Functional bug report
about: Something in the docs is functionally broken
title: ""
labels: ""
assignees: ""
---

#### Describe what function in the docs is broken

For example, write "Broken link on Google Container Registry page" or "Long resource names are cut off in left navigation pane."

#### Provide steps to reproduce

Steps to reproduce the behavior:

1. Go to [URL]
2. Scroll to [xxx] section
3. Select [xxx]

#### Expected behavior

Write a clear and concise description of what you expect to happen.

#### Actual behavior

Write a clear and concise description of what actually happens.

#### Screenshots

If applicable, add screenshots to demonstrate the problem.

#### System info

- OS: [e.g., macOS]
- OS version: [e.g., 13.0]
- Browser if applicable: [e.g., Chrome, Firefox]
- Browser version: [e.g., 106]

#### Notes

Add any other info you want to provide.
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!--- Provide a short summary of your changes in the Title above -->

#### Description

<!--- Describe your changes in detail. What problems do they solve? -->

#### Related issue

<!--- Provide a link to the GitHub issue this fixes. -->

#### Types of changes

<!--- What types of changes does this merge request introduce? Put an `x` in all the boxes that apply: -->

- [ ] 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

<!--- Put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, please ask. We're here to help! -->

- [ ] 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.
38 changes: 38 additions & 0 deletions .github/actions/PREview-data/action.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## NOTE: THIS IS A COMPOSABLE ACTION, NOT A WORKFLOW.
name: "PREview: Data"
description: "Caluculate branch, bucket, and PREview URL."

outputs:
url:
description: "PREview URL"
value: ${{ steps.data.outputs.url }}
branch:
description: "Branch Name"
value: ${{ steps.data.outputs.branch }}
bucket:
description: "Bucket for PREview"
value: ${{ steps.data.outputs.bucket }}

runs:
using: "composite"
steps:
- name: Determine branch shortname, bucket name and URL.
id: data
shell: bash
run: |
BRANCH=`echo ${GITHUB_HEAD_REF} | sed 's/.*\///'`
echo "::set-output name=branch::${BRANCH}"
echo "::set-output name=bucket::mondoo-pre-docs-${BRANCH}/docs"
echo "::set-output name=url::https://mondoo-pre-docs-${BRANCH}.storage.googleapis.com/docs/index.html"
- name: Determine branch shortname and bucket name
shell: bash
run: |
BRANCH=`echo ${GITHUB_HEAD_REF} | sed 's/.*\///'`
echo BRANCH=${BRANCH} >> $GITHUB_ENV
echo BUCKET=mondoo-pre-docs-${BRANCH} >> $GITHUB_ENV
echo URL=https://mondoo-pre-docs-${BRANCH}.storage.googleapis.com/docs/index.html >> $GITHUB_ENV
- name: Verify env variables
shell: bash
id: env
run: |
env
15 changes: 15 additions & 0 deletions .github/actions/spelling/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# check-spelling/check-spelling configuration

| File | Purpose | Format | Info |
| -------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| [allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow) |
| [reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject) |
| [excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes) |
| [only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only) |
| [patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) |
| [line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) |
| [expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) |
| [advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice) |

Note: you can replace any of these files with a directory by the same name (minus the suffix)
and then include multiple files inside that directory (with that suffix) to merge multiple files together.
23 changes: 23 additions & 0 deletions .github/actions/spelling/advice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
<details><summary>If the flagged items are false positives</summary>

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](https://www.regexplanet.com/advanced/perl/) 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](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
try adding it to the `patterns.txt` file.

Patterns are Perl 5 Regular Expressions - you can [test](https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.

Note that patterns can't match multiline strings.

</details>
Empty file.
50 changes: 50 additions & 0 deletions .github/actions/spelling/excludes.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)go\.sum$
(?:^|/)package(?:-lock|)\.json$
(?:^|/)vendor/
ignore$
\.a$
\.ai$
\.avi$
\.bmp$
\.bz2$
\.crt$
\.dll$
\.DS_Store$
\.eot$
\.exe$
\.gif$
\.gitattributes$
\.graffle$
\.gz$
\.icns$
\.ico$
\.jar$
\.jpe?g$
\.key$
\.lib$
\.lock$
\.map$
\.min\..
\.mod$
\.mp[34]$
\.o$
\.ocf$
\.otf$
\.pdf$
\.pem$
\.png$
\.psd$
\.s$
\.svg$
\.tiff?$
\.ttf$
\.wav$
\.webm$
\.webp$
\.woff2?$
\.zip$
^\.github/actions/spelling/
^\Q.github/workflows/spelling.yml\E$
Loading

0 comments on commit add2624

Please sign in to comment.