Skip to content

Commit

Permalink
📖 Fix link pointing to missing documentation (#552)
Browse files Browse the repository at this point in the history 
Signed-off-by: Mauro Morales <[email protected]>

Signed-off-by: Mauro Morales <[email protected]>
  • Loading branch information
@mauromorales
mauromorales authored Dec 10, 2022
1 parent 5614294 commit c313143
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Kairos can be used to:
- Manage the cluster lifecycle with Kubernetes—from building to provisioning, and upgrading :rocket:
- Create a multiple—node, a single cluster that spans up across regions :earth_africa:

For comprehensive docs, tutorials, and examples see our [documentation](https://kairos.io/quickstart).
For comprehensive docs, tutorials, and examples see our [documentation](https://kairos.io/docs/getting-started/).

## Project status

Expand Down

1 comment on commit c313143

@github-actions
Copy link

Choose a reason for hiding this comment

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

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 👼 SARIF report for details.

Unrecognized words (1)

videotest

Previously acknowledged words that are now absent browserconfig css xml :arrow_right:
To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the [email protected]:kairos-io/kairos.git repository
on the master branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/kairos-io/kairos/actions/runs/3665293910/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary

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

Dictionary Entries Covers
cspell:cpp/src/cpp.txt 30216 175
cspell:software-terms/src/software-terms.txt 1237 136
cspell:python/src/python/python-lib.txt 3873 64
cspell:node/node.txt 1768 60
cspell:php/php.txt 2597 53
cspell:win32/src/win32.txt 53509 31
cspell:npm/npm.txt 288 31
cspell:typescript/typescript.txt 1211 30
cspell:node/src/node-old.txt 730 28
cspell:golang/go.txt 3412 27

Consider adding them using (in .github/workflows/spelling.yml):

      with:
        extra_dictionaries:
          cspell:cpp/src/cpp.txt
          cspell:software-terms/src/software-terms.txt
          cspell:python/src/python/python-lib.txt
          cspell:node/node.txt
          cspell:php/php.txt
          cspell:win32/src/win32.txt
          cspell:npm/npm.txt
          cspell:typescript/typescript.txt
          cspell:node/src/node-old.txt
          cspell:golang/go.txt

To stop checking additional dictionaries, add:

      with:
        check_extra_dictionaries: ''
Pattern suggestions ✂️ (17)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns
# hit-count: 54 file-count: 30
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)

# hit-count: 22 file-count: 16
# githubusercontent
/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*

# hit-count: 20 file-count: 9
# Compiler flags
(?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})

# hit-count: 17 file-count: 12
# uuid:
\b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b

# hit-count: 12 file-count: 5
# URL escaped characters
\%[0-9A-F][A-F]

# hit-count: 11 file-count: 7
# hex runs
\b[0-9a-fA-F]{16,}\b

# hit-count: 8 file-count: 8
# tar arguments
\b(?:\\n|)g?tar(?:\.exe|)(?:(?:\s+--[-a-zA-Z]+|\s+-[a-zA-Z]+|\s[ABGJMOPRSUWZacdfh-pr-xz]+\b)(?:=[^ ]*|))+

# hit-count: 6 file-count: 2
# version suffix <word>v#
(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))

# hit-count: 3 file-count: 2
# IPv6
\b(?:[0-9a-fA-F]{0,4}:){3,7}[0-9a-fA-F]{0,4}\b

# hit-count: 2 file-count: 2
# Google Calendar
\bcalendar\.google\.com/calendar(?:/u/\d+|)/embed\?src=[@./?=\w&%]+

# hit-count: 2 file-count: 2
# ipfs url
/ipfs/[0-9a-z]*

# hit-count: 1 file-count: 1
# Amazon
\bamazon\.com/[-\w]+/(?:dp/[0-9A-Z]+|)

# hit-count: 1 file-count: 1
# Slack
\bslack\.com/[-0-9a-zA-Z/_~?&=.]*

# hit-count: 1 file-count: 1
# shields.io
\bshields\.io/[-\w/%?=&.:+;,]*

# hit-count: 1 file-count: 1
# Wikipedia
\ben\.wikipedia\.org/wiki/[-\w%.#]+

# hit-count: 1 file-count: 1
# hex digits including css/html color classes:
(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|u\d+)\b

# hit-count: 1 file-count: 1
# go install
go install(?:\s+[a-z]+\.[-@\w/.]+)+
Errors (2)

See the 📜action log or 👼 SARIF report for details.

❌ Errors Count
ℹ️ candidate-pattern 35
❌ forbidden-pattern 20

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.

Please sign in to comment.