docs: populate charm documentation #10
docs.yaml
on: pull_request
docs-checks
/
vale
13s
docs-checks
/
linkcheck
1m 35s
Annotations
8 errors and 3 warnings
|
docs-checks / vale
Vale and reviewdog exited with status code: 1
|
|
docs-checks / vale:
docs/explanation/charm-architecture.md#L131
[vale] reported by reviewdog 🐶
[Canonical.000-US-spellcheck] The word 'teardown' seems to be misspelled.
Raw Output:
{"message": "[Canonical.000-US-spellcheck] The word 'teardown' seems to be misspelled.", "location": {"path": "docs/explanation/charm-architecture.md", "range": {"start": {"line": 131, "column": 46}}}, "severity": "ERROR"}
|
|
docs-checks / vale:
docs/explanation/charm-architecture.md#L131
[vale] reported by reviewdog 🐶
[Canonical.000-US-spellcheck] The word 'systemd' seems to be misspelled.
Raw Output:
{"message": "[Canonical.000-US-spellcheck] The word 'systemd' seems to be misspelled.", "location": {"path": "docs/explanation/charm-architecture.md", "range": {"start": {"line": 131, "column": 38}}}, "severity": "ERROR"}
|
|
docs-checks / vale:
docs/how-to/configure.md#L110
[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Related Commands' should use sentence-style capitalisation.
Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Related Commands' should use sentence-style capitalisation.", "location": {"path": "docs/how-to/configure.md", "range": {"start": {"line": 110, "column": 4}}}, "severity": "ERROR"}
|
|
docs-checks / vale:
docs/how-to/configure.md#L78
[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Example: Full Configuration' should use sentence-style capitalisation.
Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Example: Full Configuration' should use sentence-style capitalisation.", "location": {"path": "docs/how-to/configure.md", "range": {"start": {"line": 78, "column": 4}}}, "severity": "ERROR"}
|
|
docs-checks / vale:
docs/how-to/configure.md#L48
[vale] reported by reviewdog 🐶
[Canonical.000-US-spellcheck] The word 'proxied' seems to be misspelled.
Raw Output:
{"message": "[Canonical.000-US-spellcheck] The word 'proxied' seems to be misspelled.", "location": {"path": "docs/how-to/configure.md", "range": {"start": {"line": 48, "column": 71}}}, "severity": "ERROR"}
|
|
docs-checks / vale:
docs/how-to/configure.md#L20
[vale] reported by reviewdog 🐶
[Canonical.007-Headings-sentence-case] 'Configuration Options' should use sentence-style capitalisation.
Raw Output:
{"message": "[Canonical.007-Headings-sentence-case] 'Configuration Options' should use sentence-style capitalisation.", "location": {"path": "docs/how-to/configure.md", "range": {"start": {"line": 20, "column": 4}}}, "severity": "ERROR"}
|
|
docs-checks / linkcheck
Process completed with exit code 2.
|
|
docs-checks / vale:
docs/how-to/configure.md#L68
[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": "docs/how-to/configure.md", "range": {"start": {"line": 68, "column": 67}}}, "severity": "WARNING"}
|
|
docs-checks / vale:
docs/how-to/configure.md#L20
[vale] reported by reviewdog 🐶
[Canonical.011-Headings-not-followed-by-heading] Avoid stacked headings. There should be content for each heading.
Raw Output:
{"message": "[Canonical.011-Headings-not-followed-by-heading] Avoid stacked headings. There should be content for each heading.", "location": {"path": "docs/how-to/configure.md", "range": {"start": {"line": 20, "column": 1}}}, "severity": "WARNING"}
|
|
docs-checks / vale:
README.md#L20
[vale] reported by reviewdog 🐶
[Canonical.011-Headings-not-followed-by-heading] Avoid stacked headings. There should be content for each heading.
Raw Output:
{"message": "[Canonical.011-Headings-not-followed-by-heading] Avoid stacked headings. There should be content for each heading.", "location": {"path": "README.md", "range": {"start": {"line": 20, "column": 1}}}, "severity": "WARNING"}
|