From 2f9eae106e2a2bd449ae8eb418f2d8340a26fb6e Mon Sep 17 00:00:00 2001 From: Daniel Mohns Date: Thu, 26 Oct 2023 12:59:48 +0200 Subject: [PATCH] Improve `yamllint` configuration --- .github/workflows/mkdocs-gh-pages.yaml | 10 +++++----- .yamllint | 5 +++++ mkdocs.yml | 8 ++++---- 3 files changed, 14 insertions(+), 9 deletions(-) diff --git a/.github/workflows/mkdocs-gh-pages.yaml b/.github/workflows/mkdocs-gh-pages.yaml index 941e4fb..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" - 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/.yamllint b/.yamllint index 3736522..7f2054c 100644 --- a/.yamllint +++ b/.yamllint @@ -4,5 +4,10 @@ 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 49f6723..f6b161d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -125,8 +125,8 @@ nav: - cbor header d5440a5437974c6e898fad616e623875: AirLink Devices/Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0/cbor header d5440a5437974c6e898fad616e623875.md - AirLink Server: - Home: AirLink Server.md - - Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2: - - AirLink ID 34a6a602814745ab9a28940d1d3af142: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/AirLink ID 34a6a602814745ab9a28940d1d3af142.md + - ? Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2 + : - AirLink ID 34a6a602814745ab9a28940d1d3af142: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/AirLink ID 34a6a602814745ab9a28940d1d3af142.md - Config status e g Firmware version 988f3023800e4866a1e1261b6fa36f35: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/Config status e g Firmware version 988f3023800e4866a1e1261b6fa36f35.md - Customer Provisioning Information c6f47efb3ff542858cf76d07d5186883: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/Customer Provisioning Information c6f47efb3ff542858cf76d07d5186883.md - Device Administration Configuration 30d49450eb1a44ccbd1ac620dcc63072: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/Device Administration Configuration 30d49450eb1a44ccbd1ac620dcc63072.md @@ -136,8 +136,8 @@ nav: - PAYG Token Secret, Message ID b093831971814a90b318c81b731c49f2: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/PAYG Token Secret, Message ID b093831971814a90b318c81b731c49f2.md - Rule chain alarm Thresholds c22121ef28224db891e765cb24ba59d5: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/Rule chain alarm Thresholds c22121ef28224db891e765cb24ba59d5.md - Timeseries Data 5c5d4a527a5e4fa18fc32c31fe1fba8c: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/Timeseries Data 5c5d4a527a5e4fa18fc32c31fe1fba8c.md - - How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933: - - Home: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933.md + - ? How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933 + : - Home: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc5 06431c838c41eb1c407933.md - Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548: - Analytics for metrics 5d54acc723e1438499645a7d8fd8e7b5: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Analytics for metrics 5d54acc723e1438499645a7d8fd8e7b5.md - API 2b45090acf5a4dd3bb6c93cf09bbd247: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/API 2b45090acf5a4dd3bb6c93cf09bbd247.md