From 8de5fb4257f0fa491cd6f23e9f0f276094a64418 Mon Sep 17 00:00:00 2001 From: Daniel Mohns Date: Thu, 26 Oct 2023 10:59:00 +0200 Subject: [PATCH 1/4] Improve `markdownlint` CI setup --- .../workflows/{lint.yaml => markdown-lint.yaml} | 15 +++++++++------ .markdownlint-cli2.yaml | 13 +++++++++++++ .markdownlint.yaml | 10 ---------- 3 files changed, 22 insertions(+), 16 deletions(-) rename .github/workflows/{lint.yaml => markdown-lint.yaml} (60%) create mode 100644 .markdownlint-cli2.yaml delete mode 100644 .markdownlint.yaml diff --git a/.github/workflows/lint.yaml b/.github/workflows/markdown-lint.yaml similarity index 60% rename from .github/workflows/lint.yaml rename to .github/workflows/markdown-lint.yaml index a1416af..392e6e8 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/markdown-lint.yaml @@ -1,15 +1,18 @@ -name: Lint +name: Markdown Lint -on: [push, pull_request] +on: + push: + branches: + - main + pull_request: + branches: + - main jobs: - lint: + markdownlint: 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/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml new file mode 100644 index 0000000..8514891 --- /dev/null +++ b/.markdownlint-cli2.yaml @@ -0,0 +1,13 @@ +# 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" + +# Define glob expressions to ignore +# ignores: +# - "ignore*.md" \ No newline at end of file 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 From e4c4d2cccf93efa1ba8741067da742a7c4ad3d3c Mon Sep 17 00:00:00 2001 From: Daniel Mohns Date: Thu, 26 Oct 2023 12:27:55 +0200 Subject: [PATCH 2/4] Update CI --- .ecrc | 5 ++++ .editorconfig | 6 ++++ .github/workflows/check-generic.yaml | 42 ++++++++++++++++++++++++++++ .github/workflows/markdown-lint.yaml | 18 ------------ .markdownlint-cli2.yaml | 4 --- .yamllint | 8 ++++++ 6 files changed, 61 insertions(+), 22 deletions(-) create mode 100644 .ecrc create mode 100644 .editorconfig create mode 100644 .github/workflows/check-generic.yaml delete mode 100644 .github/workflows/markdown-lint.yaml create mode 100644 .yamllint 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/markdown-lint.yaml b/.github/workflows/markdown-lint.yaml deleted file mode 100644 index 392e6e8..0000000 --- a/.github/workflows/markdown-lint.yaml +++ /dev/null @@ -1,18 +0,0 @@ -name: Markdown Lint - -on: - push: - branches: - - main - pull_request: - branches: - - main - -jobs: - markdownlint: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Run markdownlint - uses: DavidAnson/markdownlint-cli2-action@v13 diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index 8514891..845b406 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -7,7 +7,3 @@ config: # Define glob expressions to use (only valid at root) globs: - "**/*.md" - -# Define glob expressions to ignore -# ignores: -# - "ignore*.md" \ No newline at end of file diff --git a/.yamllint b/.yamllint new file mode 100644 index 0000000..3736522 --- /dev/null +++ b/.yamllint @@ -0,0 +1,8 @@ +extends: default + +rules: + document-start: disable + indentation: + spaces: 2 + truthy: + check-keys: false From 955ebd89083690036bcfb985fa323a1edcc4adc3 Mon Sep 17 00:00:00 2001 From: Daniel Mohns Date: Thu, 26 Oct 2023 12:37:34 +0200 Subject: [PATCH 3/4] Apply yamllint --- .github/workflows/mkdocs-gh-pages.yaml | 2 +- mkdocs.yml | 94 +++++++++++++------------- 2 files changed, 48 insertions(+), 48 deletions(-) diff --git a/.github/workflows/mkdocs-gh-pages.yaml b/.github/workflows/mkdocs-gh-pages.yaml index a42788b..941e4fb 100644 --- a/.github/workflows/mkdocs-gh-pages.yaml +++ b/.github/workflows/mkdocs-gh-pages.yaml @@ -31,7 +31,7 @@ jobs: uses: actions/configure-pages@v2 - uses: "actions/setup-python@v3" with: - python-version: "3.10" + python-version: "3.10" - name: Install MkDocs run: "pip install mkdocs mkdocs-material" - name: Build with MkDocs diff --git a/mkdocs.yml b/mkdocs.yml index 74a181c..49f6723 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -115,54 +115,54 @@ extra_javascript: nav: - Home: index.md - AirLink App: - - Home: AirLink App.md - - Visual Studio setup and to Git library instruction 1c38135f4b6b4e3db7ed0d2b3a30ccae: AirLink App/Visual Studio setup and to Git library instruction 1c38135f4b6b4e3db7ed0d2b3a30ccae.md + - Home: AirLink App.md + - Visual Studio setup and to Git library instruction 1c38135f4b6b4e3db7ed0d2b3a30ccae: AirLink App/Visual Studio setup and to Git library instruction 1c38135f4b6b4e3db7ed0d2b3a30ccae.md - AirLink Devices: - - Home: AirLink Devices.md - - Range Testing Results ef4c4ece8fba4542830d415dc0fa1a42: AirLink Devices/Range Testing Results ef4c4ece8fba4542830d415dc0fa1a42.md - - Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0: - - COSE command cmd 854e60d9cf7c42bdb3ccdd5571389d76: AirLink Devices/Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0/COSE command cmd 854e60d9cf7c42bdb3ccdd5571389d76.md - - cbor header d5440a5437974c6e898fad616e623875: AirLink Devices/Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0/cbor header d5440a5437974c6e898fad616e623875.md + - Home: AirLink Devices.md + - Range Testing Results ef4c4ece8fba4542830d415dc0fa1a42: AirLink Devices/Range Testing Results ef4c4ece8fba4542830d415dc0fa1a42.md + - Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0: + - COSE command cmd 854e60d9cf7c42bdb3ccdd5571389d76: AirLink Devices/Nexus Command Resource nxc ed4247090ba4475583e05f72cc537ff0/COSE command cmd 854e60d9cf7c42bdb3ccdd5571389d76.md + - 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 - - 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 - - Device provisioning or claiming keys c74f19fa1fe54dddb737c804e3d103da: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/Device provisioning or claiming keys c74f19fa1fe54dddb737c804e3d103da.md - - PAYG Command or Token ef142acab5b44b3a9fcb61522d5acaf5: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/PAYG Command or Token ef142acab5b44b3a9fcb61522d5acaf5.md - - PAYG Status 11596ed3dbde4bf4a6f9621ddc6dcede: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/PAYG Status 11596ed3dbde4bf4a6f9621ddc6dcede.md - - 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 - - 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 - - Basic Data External forwarding and Workflow trigge 04a000ddf27045a58324c05c69129708: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Basic Data External forwarding and Workflow trigge 04a000ddf27045a58324c05c69129708.md - - Chart options e17ee203b9f24c1aada36ec4907d4e53: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Chart options e17ee203b9f24c1aada36ec4907d4e53.md - - Customer management 8db790b517ed40b0ad46a54d5e22d3e6: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Customer management 8db790b517ed40b0ad46a54d5e22d3e6.md - - Customer support c389bb7fd1314df5b11b9229e3913f07: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Customer support c389bb7fd1314df5b11b9229e3913f07.md - - Dashboard UX 5dad589f771c4a029339bbaf7a3c88eb: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Dashboard UX 5dad589f771c4a029339bbaf7a3c88eb.md - - Data management possiblity 452df22571f145aeb569939c9146bc21: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Data management possiblity 452df22571f145aeb569939c9146bc21.md - - Device management 89dd4a0b8d174648b6b88b68ba915f89: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Device management 89dd4a0b8d174648b6b88b68ba915f89.md - - Device Sandbox codebase 4ad4a1269d814bc498180c06887a9355: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Device Sandbox codebase 4ad4a1269d814bc498180c06887a9355.md - - Feature cost a078e1055d1c4dc3be68b1c194a6d0bc: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Feature cost a078e1055d1c4dc3be68b1c194a6d0bc.md - - Feature dev speed 7468c1c2b41f4e07a5c21f60089fcc1d: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Feature dev speed 7468c1c2b41f4e07a5c21f60089fcc1d.md - - Filters on displayed charts 085f49ada5944cadb42c9865898b0232: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Filters on displayed charts 085f49ada5944cadb42c9865898b0232.md - - Git source Link 3d7d92e5cc5f458db244260d3b9424ac: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Git source Link 3d7d92e5cc5f458db244260d3b9424ac.md - - Interoperable format compatibility 2566d647a3e4402890f3e48472e3b59f: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Interoperable format compatibility 2566d647a3e4402890f3e48472e3b59f.md - - IoT Comms 7fccfe926a3b4b9fafa201822f7a164f: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/IoT Comms 7fccfe926a3b4b9fafa201822f7a164f.md - - Lock-in risk c4cee9ccea7b4add8234d7af062f0a1a: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Lock-in risk c4cee9ccea7b4add8234d7af062f0a1a.md - - Login based filtering ae8d17cc1af74ff99a1ec4324e53e3ba: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Login based filtering ae8d17cc1af74ff99a1ec4324e53e3ba.md - - Model f4340e4dcc1c424684d2345ff7352be7: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Model f4340e4dcc1c424684d2345ff7352be7.md - - Open source 387cd4e6cba54538af21c020f6b19cf1: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Open source 387cd4e6cba54538af21c020f6b19cf1.md - - Performance scale e6052517c5fa41a29509227c87dcf768: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Performance scale e6052517c5fa41a29509227c87dcf768.md - - Programming language dafec3aef11545a789df7e5c5326f130: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Programming language dafec3aef11545a789df7e5c5326f130.md - - SSO types for users customers 565c4ec86bef46c78ece2158d6f80cd6: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/SSO types for users customers 565c4ec86bef46c78ece2158d6f80cd6.md - - Total Cost of Ownership for paid premium option - 6077e5705a174cdc86fe64348bf16fdb: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Total Cost of Ownership for paid premium option - 6077e5705a174cdc86fe64348bf16fdb.md - - Vendor info any risk to business 6ecbb09542ef478caeb5b327d783d74e: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Vendor info any risk to business 6ecbb09542ef478caeb5b327d783d74e.md + - 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 + - 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 + - Device provisioning or claiming keys c74f19fa1fe54dddb737c804e3d103da: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/Device provisioning or claiming keys c74f19fa1fe54dddb737c804e3d103da.md + - PAYG Command or Token ef142acab5b44b3a9fcb61522d5acaf5: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/PAYG Command or Token ef142acab5b44b3a9fcb61522d5acaf5.md + - PAYG Status 11596ed3dbde4bf4a6f9621ddc6dcede: AirLink Server/Attribute Scopes for AirLink resource properties 81cd9ab605c54348a6c03bbef738dbd2/PAYG Status 11596ed3dbde4bf4a6f9621ddc6dcede.md + - 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 + - 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 + - Basic Data External forwarding and Workflow trigge 04a000ddf27045a58324c05c69129708: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Basic Data External forwarding and Workflow trigge 04a000ddf27045a58324c05c69129708.md + - Chart options e17ee203b9f24c1aada36ec4907d4e53: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Chart options e17ee203b9f24c1aada36ec4907d4e53.md + - Customer management 8db790b517ed40b0ad46a54d5e22d3e6: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Customer management 8db790b517ed40b0ad46a54d5e22d3e6.md + - Customer support c389bb7fd1314df5b11b9229e3913f07: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Customer support c389bb7fd1314df5b11b9229e3913f07.md + - Dashboard UX 5dad589f771c4a029339bbaf7a3c88eb: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Dashboard UX 5dad589f771c4a029339bbaf7a3c88eb.md + - Data management possiblity 452df22571f145aeb569939c9146bc21: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Data management possiblity 452df22571f145aeb569939c9146bc21.md + - Device management 89dd4a0b8d174648b6b88b68ba915f89: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Device management 89dd4a0b8d174648b6b88b68ba915f89.md + - Device Sandbox codebase 4ad4a1269d814bc498180c06887a9355: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Device Sandbox codebase 4ad4a1269d814bc498180c06887a9355.md + - Feature cost a078e1055d1c4dc3be68b1c194a6d0bc: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Feature cost a078e1055d1c4dc3be68b1c194a6d0bc.md + - Feature dev speed 7468c1c2b41f4e07a5c21f60089fcc1d: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Feature dev speed 7468c1c2b41f4e07a5c21f60089fcc1d.md + - Filters on displayed charts 085f49ada5944cadb42c9865898b0232: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Filters on displayed charts 085f49ada5944cadb42c9865898b0232.md + - Git source Link 3d7d92e5cc5f458db244260d3b9424ac: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Git source Link 3d7d92e5cc5f458db244260d3b9424ac.md + - Interoperable format compatibility 2566d647a3e4402890f3e48472e3b59f: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Interoperable format compatibility 2566d647a3e4402890f3e48472e3b59f.md + - IoT Comms 7fccfe926a3b4b9fafa201822f7a164f: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/IoT Comms 7fccfe926a3b4b9fafa201822f7a164f.md + - Lock-in risk c4cee9ccea7b4add8234d7af062f0a1a: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Lock-in risk c4cee9ccea7b4add8234d7af062f0a1a.md + - Login based filtering ae8d17cc1af74ff99a1ec4324e53e3ba: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Login based filtering ae8d17cc1af74ff99a1ec4324e53e3ba.md + - Model f4340e4dcc1c424684d2345ff7352be7: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Model f4340e4dcc1c424684d2345ff7352be7.md + - Open source 387cd4e6cba54538af21c020f6b19cf1: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Open source 387cd4e6cba54538af21c020f6b19cf1.md + - Performance scale e6052517c5fa41a29509227c87dcf768: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Performance scale e6052517c5fa41a29509227c87dcf768.md + - Programming language dafec3aef11545a789df7e5c5326f130: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Programming language dafec3aef11545a789df7e5c5326f130.md + - SSO types for users customers 565c4ec86bef46c78ece2158d6f80cd6: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/SSO types for users customers 565c4ec86bef46c78ece2158d6f80cd6.md + - Total Cost of Ownership for paid premium option - 6077e5705a174cdc86fe64348bf16fdb: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Total Cost of Ownership for paid premium option - 6077e5705a174cdc86fe64348bf16fdb.md + - Vendor info any risk to business 6ecbb09542ef478caeb5b327d783d74e: AirLink Server/How we chose Thingsboard io for AirLink Server fdf5dfccc506431c838c41eb1c407933/Last Round Alternatives 0ab7b7c54fa646a9ae62f45fe89de548/Vendor info any risk to business 6ecbb09542ef478caeb5b327d783d74e.md - Quick-start guide: Quick-start guide.md - Connecting to Solaris or Angaza: Connecting to Solaris or Angaza.md From 2f9eae106e2a2bd449ae8eb418f2d8340a26fb6e Mon Sep 17 00:00:00 2001 From: Daniel Mohns Date: Thu, 26 Oct 2023 12:59:48 +0200 Subject: [PATCH 4/4] 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