Updates to README, templates, and workflows #2
Annotations
9 errors and 11 warnings
Style checker:
templates/tutorial/t-overview.md#L25
[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Juju' instead of 'juju'.
Raw Output:
{"message": "[Vale.Terms] Use 'Juju' instead of 'juju'.", "location": {"path": "templates/tutorial/t-overview.md", "range": {"start": {"line": 25, "column": 79}}}, "severity": "ERROR"}
|
Style checker:
templates/overview.md#L29
[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'APIs'?
Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'APIs'?", "location": {"path": "templates/overview.md", "range": {"start": {"line": 29, "column": 68}}}, "severity": "ERROR"}
|
Style checker:
templates/overview.md#L37
[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Launchpad' instead of 'LaunchPad'.
Raw Output:
{"message": "[Vale.Terms] Use 'Launchpad' instead of 'LaunchPad'.", "location": {"path": "templates/overview.md", "range": {"start": {"line": 37, "column": 35}}}, "severity": "ERROR"}
|
Style checker
reviewdog: Too many results (annotations) in diff.
You may miss some annotations due to GitHub limitation for annotation created by logging command.
Please check GitHub Actions log console to see all results.
Limitation:
- 10 warning annotations and 10 error annotations per step
- 50 annotations per job (sum of annotations from all the steps)
- 50 annotations per run (separate from the job annotations, these annotations aren't created by users)
Source: https://git.luolix.topmunity/t5/GitHub-Actions/Maximum-number-of-annotations-that-can-be-created-using-GitHub/m-p/39085
|
Style checker:
templates/overview.md#L48
[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Navlink'?
Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Navlink'?", "location": {"path": "templates/overview.md", "range": {"start": {"line": 48, "column": 18}}}, "severity": "ERROR"}
|
Style checker:
README.md#L24
[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Sharding'?
Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Sharding'?", "location": {"path": "README.md", "range": {"start": {"line": 24, "column": 122}}}, "severity": "ERROR"}
|
Style checker:
README.md#L36
[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Jira'?
Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Jira'?", "location": {"path": "README.md", "range": {"start": {"line": 36, "column": 29}}}, "severity": "ERROR"}
|
Style checker:
README.md#L37
[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Diataxis'?
Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Diataxis'?", "location": {"path": "README.md", "range": {"start": {"line": 37, "column": 67}}}, "severity": "ERROR"}
|
Style checker
reviewdog exited with status code: 1
|
Style checker
The following actions uses Node.js version which is deprecated and will be forced to run on node20: actions/checkout@v3. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
|
Style checker:
templates/tutorial/t-page.md#L14
[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] '{Section A}' should use sentence-style capitalisation.
Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] '{Section A}' should use sentence-style capitalisation.", "location": {"path": "templates/tutorial/t-page.md", "range": {"start": {"line": 14, "column": 64}}}, "severity": "WARNING"}
|
Style checker:
templates/tutorial/t-page.md#L18
[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] '{Section B}' should use sentence-style capitalisation.
Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] '{Section B}' should use sentence-style capitalisation.", "location": {"path": "templates/tutorial/t-page.md", "range": {"start": {"line": 18, "column": 64}}}, "severity": "WARNING"}
|
Style checker:
templates/tutorial/t-overview.md#L1
[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Charmed {X} Tutorial' should use sentence-style capitalisation.
Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Charmed {X} Tutorial' should use sentence-style capitalisation.", "location": {"path": "templates/tutorial/t-overview.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "WARNING"}
|
Style checker:
templates/tutorial/t-overview.md#L25
[vale] reported by reviewdog 🐶
[Canonical.004-Canonical-product-names] Use 'Juju' instead of 'juju'
Raw Output:
{"message": "[Canonical.004-Canonical-product-names] Use 'Juju' instead of 'juju'", "location": {"path": "templates/tutorial/t-overview.md", "range": {"start": {"line": 25, "column": 79}}}, "severity": "INFO"}
|
Style checker:
templates/overview.md#L8
[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Charmed {X} Documentation' should use sentence-style capitalisation.
Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Charmed {X} Documentation' should use sentence-style capitalisation.", "location": {"path": "templates/overview.md", "range": {"start": {"line": 8, "column": 3}}}, "severity": "WARNING"}
|
Style checker:
templates/overview.md#L37
[vale] reported by reviewdog 🐶
[Canonical.004-Canonical-product-names] Use 'Launchpad' instead of 'LaunchPad'
Raw Output:
{"message": "[Canonical.004-Canonical-product-names] Use 'Launchpad' instead of 'LaunchPad'", "location": {"path": "templates/overview.md", "range": {"start": {"line": 37, "column": 35}}}, "severity": "INFO"}
|
Style checker:
templates/overview.md#L41
[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Licensing & Trademark' should use sentence-style capitalisation.
Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Licensing \u0026 Trademark' should use sentence-style capitalisation.", "location": {"path": "templates/overview.md", "range": {"start": {"line": 41, "column": 4}}}, "severity": "WARNING"}
|
Style checker:
templates/overview.md#L44
[vale] reported by reviewdog 🐶
[Canonical.001-English-words-spelling-suggestions] Use British English spelling, 'organisation' instead of 'organization'.
Raw Output:
{"message": "[Canonical.001-English-words-spelling-suggestions] Use British English spelling, 'organisation' instead of 'organization'.", "location": {"path": "templates/overview.md", "range": {"start": {"line": 44, "column": 48}}}, "severity": "INFO"}
|
Style checker:
templates/overview.md#L50
[vale] reported by reviewdog 🐶
[Canonical.013-Spell-out-numbers-below-10] Consider using 'one' instead of '1'
Raw Output:
{"message": "[Canonical.013-Spell-out-numbers-below-10] Consider using 'one' instead of '1'", "location": {"path": "templates/overview.md", "range": {"start": {"line": 50, "column": 3}}}, "severity": "WARNING"}
|
Style checker:
templates/overview.md#L51
[vale] reported by reviewdog 🐶
[Canonical.013-Spell-out-numbers-below-10] Consider using 'one' instead of '1'
Raw Output:
{"message": "[Canonical.013-Spell-out-numbers-below-10] Consider using 'one' instead of '1'", "location": {"path": "templates/overview.md", "range": {"start": {"line": 51, "column": 3}}}, "severity": "WARNING"}
|