Skip to content

Commit

Permalink
test docs linter within docs
Browse files Browse the repository at this point in the history
  • Loading branch information
louiseschmidtgen committed May 31, 2024
1 parent 2eb66a4 commit eda9ce6
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
id: changed-markdown-files
with:
files: |
**.md
docs/**/*.md
- uses: DavidAnson/markdownlint-cli2-action@v16
if: steps.changed-markdown-files.outputs.any_changed == 'true'
with:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/k8s)


#TODO: remove this linter teeeeeest way to long line -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

**Canonical Kubernetes** is the fastest, easiest way to deploy a fully-conformant Kubernetes cluster. Harnessing pure upstream Kubernetes, this distribution adds the missing pieces (e.g. ingress, dns, networking) for a zero-ops experience.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/snap/explanation/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Yes. Canonical Kubernetes is designed to be eminently scalable. You can start
with a single node and add more as and when the need arises. Scale up or down
at any time. Systems with more than three nodes will automatically become
Highly Available.

#TODO: remove this linter teeeeeest way to long line -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Check failure on line 42 in docs/src/snap/explanation/about.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

docs/src/snap/explanation/about.md:42:81 MD013/line-length Line length [Expected: 80; Actual: 270] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md

Check failure on line 42 in docs/src/snap/explanation/about.md

View workflow job for this annotation

GitHub Actions / markdown-lint

No space after hash on atx style heading

docs/src/snap/explanation/about.md:42:1 MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#TODO: remove this linter teee..."] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md018.md

Check failure on line 42 in docs/src/snap/explanation/about.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

docs/src/snap/explanation/about.md:42:81 MD013/line-length Line length [Expected: 80; Actual: 270] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md

Check failure on line 42 in docs/src/snap/explanation/about.md

View workflow job for this annotation

GitHub Actions / markdown-lint

No space after hash on atx style heading

docs/src/snap/explanation/about.md:42:1 MD018/no-missing-space-atx No space after hash on atx style heading [Context: "#TODO: remove this linter teee..."] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md018.md
## Does it come with support?

Check failure on line 43 in docs/src/snap/explanation/about.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Headings should be surrounded by blank lines

docs/src/snap/explanation/about.md:43 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "## Does it come with support?"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md022.md

Check failure on line 43 in docs/src/snap/explanation/about.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Headings should be surrounded by blank lines

docs/src/snap/explanation/about.md:43 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "## Does it come with support?"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md022.md

Each and every user will be supported by the community. For a more detailed
Expand Down

0 comments on commit eda9ce6

Please sign in to comment.