Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs linter on Markdown files only #456

Merged
merged 7 commits into from
May 31, 2024
Merged

Docs linter on Markdown files only #456

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
514fb2e
docs linter only on markdown files
louiseschmidtgen May 31, 2024
2eb66a4
add gh runner top level permissions
louiseschmidtgen May 31, 2024
eda9ce6
test docs linter within docs
louiseschmidtgen May 31, 2024
3e59b32
cleanup
louiseschmidtgen May 31, 2024
ac9d61e
linter works so do as it says
louiseschmidtgen May 31, 2024
bf27186
test if ignore files works
louiseschmidtgen May 31, 2024
8eedd03
cleanup
louiseschmidtgen May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions .github/workflows/markdown.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@ name: "Docs: Markdown lint"

on: [push, pull_request]

permissions:
contents: read

jobs:
markdown-lint:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v44
id: changed-files
with:
files: |
docs/src/snap/**
docs/src/charm/**
- uses: DavidAnson/markdownlint-cli2-action@v16
if: steps.changed-files.outputs.any_changed == 'true'
with:
config: 'docs/src/.markdownlint.json'
globs: ${{ steps.changed-files.outputs.all_changed_files }}
separator: ","


- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: tj-actions/changed-files@v44
id: changed-markdown-files
with:
files: |
docs/**/*.md
louiseschmidtgen marked this conversation as resolved.
Show resolved Hide resolved
- uses: DavidAnson/markdownlint-cli2-action@v16
if: steps.changed-markdown-files.outputs.any_changed == 'true'
with:
config: "docs/src/.markdownlint.json"
globs: ${{ steps.changed-markdown-files.outputs.all_changed_files }}
separator: ","
6 changes: 4 additions & 2 deletions docs/src/snap/explanation/about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ maintain and easy to upgrade.

## What else comes with it?

In addition to the upstream Kubernetes services, Canonical Kubernetes also includes:
In addition to the upstream Kubernetes services,
Canonical Kubernetes also includes:

- a DNS service for the node
- a CNI for the node/cluster
Expand All @@ -30,7 +31,8 @@ In addition to the upstream Kubernetes services, Canonical Kubernetes also inclu

The Canonical Kubernetes snap can be installed on a Linux OS, wherever it may
be: run it in several local containers or VMs for example, or use it on
public/private cloud instances. For deploying with [Juju], a machine [charm] to deploy
public/private cloud instances.
For deploying with [Juju], a machine [charm] to deploy
the snap is also available.
Copy link
Contributor

Choose a reason for hiding this comment

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

:) this is the file I used to test it


## Can I use it to make a cluster?
Expand Down
Loading