diff --git a/.ecrc b/.ecrc new file mode 100644 index 0000000..1928534 --- /dev/null +++ b/.ecrc @@ -0,0 +1,5 @@ +{ + "Exclude": [ + ".git" + ] +} diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..30e849c --- /dev/null +++ b/.editorconfig @@ -0,0 +1,6 @@ +# EditorConfig is awesome: https://EditorConfig.org + +[*] +# Ensure consistent file encoding in UNIX style +charset = utf-8 +end_of_line = lf diff --git a/.github/workflows/check-generic.yaml b/.github/workflows/check-generic.yaml new file mode 100644 index 0000000..04b93cb --- /dev/null +++ b/.github/workflows/check-generic.yaml @@ -0,0 +1,42 @@ +# Generic checks to ease collaboration: +# - consistent file encoding in UNIX style +# - whitespaces in all purposes files like markdown, yaml, etc +name: Check Generic + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + editorconfig-checker: + name: Run editorconfig-checker + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Install editorconfig-checker + run: pipx install "editorconfig-checker" + - name: Run editorconfig-checker + run: ec . + + markdownlint: + name: Run markdownlint + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Run markdownlint-cli2 + uses: DavidAnson/markdownlint-cli2-action@v13 + + yamllint: + name: Run yamllint + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Run yamllint + run: yamllint . diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml deleted file mode 100644 index a1416af..0000000 --- a/.github/workflows/lint.yaml +++ /dev/null @@ -1,15 +0,0 @@ -name: Lint - -on: [push, pull_request] - -jobs: - lint: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Run markdownlint - uses: DavidAnson/markdownlint-cli2-action@v13 - with: - globs: | - docs/**/*.md diff --git a/.github/workflows/mkdocs-gh-pages.yaml b/.github/workflows/mkdocs-gh-pages.yaml index a42788b..eb71a7e 100644 --- a/.github/workflows/mkdocs-gh-pages.yaml +++ b/.github/workflows/mkdocs-gh-pages.yaml @@ -4,7 +4,7 @@ name: Deploy GitHub Pages with MkDocs on: # Runs on pushes targeting the default branch push: - branches: ["main"] + branches: [main] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -17,7 +17,7 @@ permissions: # Allow one concurrent deployment concurrency: - group: "pages" + group: pages cancel-in-progress: true jobs: @@ -29,17 +29,17 @@ jobs: uses: actions/checkout@v3 - name: Setup Pages uses: actions/configure-pages@v2 - - uses: "actions/setup-python@v3" + - uses: actions/setup-python@v3 with: - python-version: "3.10" + python-version: "3.10" - name: Install MkDocs - run: "pip install mkdocs mkdocs-material" + run: pip install mkdocs mkdocs-material - name: Build with MkDocs run: mkdocs build - name: Upload artifact uses: actions/upload-pages-artifact@v1 with: - path: "site/" + path: site/ # Deployment job deploy: diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 0000000..845b406 --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,9 @@ +# Disable some built-in rules +config: + line-length: false + no-inline-html: false + first-line-h1: false + +# Define glob expressions to use (only valid at root) +globs: + - "**/*.md" diff --git a/.markdownlint.yaml b/.markdownlint.yaml deleted file mode 100644 index 56e164c..0000000 --- a/.markdownlint.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# Example markdownlint configuration with all properties set to their default value - -# Default state for all rules -default: true - -# MD013/line-length - Line length -MD013: false - -# MD033/no-inline-html - Inline HTML -MD033: false diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..7f2054c --- /dev/null +++ b/.yamllint @@ -0,0 +1,13 @@ +extends: default + +rules: + document-start: disable + indentation: + spaces: 2 + line-length: disable + quoted-strings: + quote-type: double + required: only-when-needed + allow-quoted-quotes: true + truthy: + check-keys: false diff --git a/mkdocs.yml b/mkdocs.yml index cf9a989..90fd93c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -115,11 +115,11 @@ extra_javascript: nav: - Home: index.md - AirLink App: - - Home: AirLink App.md + - Home: AirLink App.md - AirLink Devices: - - Home: AirLink Devices.md - - Range Testing Results: AirLink Devices/Range Testing Results.md + - Home: AirLink Devices.md + - Range Testing Results: AirLink Devices/Range Testing Results.md - AirLink Server: - - Home: AirLink Server.md + - Home: AirLink Server.md - Quick-start guide: Quick-start guide.md - - Connecting to Solaris or Angaza: Connecting to Solaris or Angaza.md \ No newline at end of file + - Connecting to Solaris or Angaza: Connecting to Solaris or Angaza.md