From 0bcae7b88977486498bc7c15187d4a5ff3706e3a Mon Sep 17 00:00:00 2001 From: Sebastian Romero Date: Fri, 4 Feb 2022 16:23:49 +0100 Subject: [PATCH 1/4] Remove imprecise validation rule --- scripts/validation/rules/rules-spelling.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/scripts/validation/rules/rules-spelling.yml b/scripts/validation/rules/rules-spelling.yml index 97be45fd59..dd1e5ee288 100644 --- a/scripts/validation/rules/rules-spelling.yml +++ b/scripts/validation/rules/rules-spelling.yml @@ -14,12 +14,6 @@ includeCodeBlocks: false errorMessage: Incorrect spelling of 'Wi-Fi' found. -- regex: "(?!.*Flash)[fF][lL][aA][sS][hH]\\b" - shouldMatch: false - type: warning - format: markdown - errorMessage: Incorrect spelling of 'Flash' found. - - regex: "(? Date: Fri, 4 Feb 2022 16:24:09 +0100 Subject: [PATCH 2/4] Add better validation for datasheets --- scripts/validation/config/config-generic.yml | 5 ++++- scripts/validation/config/config-tutorials.yml | 1 - scripts/validation/validate.js | 5 +---- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/scripts/validation/config/config-generic.yml b/scripts/validation/config/config-generic.yml index 15e5450ec2..d7fa41e66e 100644 --- a/scripts/validation/config/config-generic.yml +++ b/scripts/validation/config/config-generic.yml @@ -19,4 +19,7 @@ validateMetadata: true verbose: true # Allows to debug the rules by outputting process messages -debug: false \ No newline at end of file +debug: false + +# Defines rules for what links not to check. Usually relative links should not be checked. +brokenLinkExcludePatterns: [^./, ^../, ^#, ^chrome://, localhost , ^assets/, ^images/] \ No newline at end of file diff --git a/scripts/validation/config/config-tutorials.yml b/scripts/validation/config/config-tutorials.yml index 819f8aa195..3c4fa6e730 100644 --- a/scripts/validation/config/config-tutorials.yml +++ b/scripts/validation/config/config-tutorials.yml @@ -10,4 +10,3 @@ validationRuleFiles: [./rules/rules-spelling.yml, ./rules/rules-trademarks.yml, allowNestedLists: false metadataSchema: rules/tutorial-metadata-schema.json -brokenLinkExcludePatterns: [^./, ^../, ^#, ^chrome://, localhost , ^assets/, ^images/] diff --git a/scripts/validation/validate.js b/scripts/validation/validate.js index 99466f57d8..0c8abda670 100644 --- a/scripts/validation/validate.js +++ b/scripts/validation/validate.js @@ -30,9 +30,6 @@ if(!allArticles || allArticles.length == 0){ // Verify that all meta data is valid JSON and contains the correct attributes if(configManager.getConfig("generic").validateMetadata){ validator.addValidation(tutorials, validateMetaData, configManager.getConfig("tutorials").metadataSchema); -} - -if(configManager.getConfig("generic").validateMetadata){ validator.addValidation(datasheets, validateMetaData, configManager.getConfig("datasheets").metadataSchema); } @@ -56,7 +53,7 @@ validator.addValidation(allArticles, validateSVGFiles); // Verify that there are no broken links if(configManager.options.checkBrokenLinks){ - validator.addValidation(tutorials, validateBrokenLinks, configManager.getConfig("tutorials").brokenLinkExcludePatterns, configManager.getConfig("generic").baseURL, configManager.options.verbose); + validator.addValidation(allArticles, validateBrokenLinks, configManager.getConfig("generic").brokenLinkExcludePatterns, configManager.getConfig("generic").baseURL, configManager.options.verbose); }; // Verify that all files in the assets folder are referenced From 2a7d4ff3b7592079baf38cd5cdab0b685724f5fd Mon Sep 17 00:00:00 2001 From: Sebastian Romero Date: Fri, 4 Feb 2022 16:26:43 +0100 Subject: [PATCH 3/4] Improve white space --- .../portenta-cat-m1-nb-iot-gnss-shield/datasheet/datasheet.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/datasheet/datasheet.md b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/datasheet/datasheet.md index 54fc43473c..3b4a2a84f2 100644 --- a/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/datasheet/datasheet.md +++ b/content/hardware/04.pro/shields/portenta-cat-m1-nb-iot-gnss-shield/datasheet/datasheet.md @@ -15,6 +15,7 @@ Internet of Things, outdoor asset tracking, positioning, cellular connectivity, # Features **Note:** This board requires a compatible MKR or Portenta board to function. Use together with the Arduino® Vision Shield is not supported. + - Cinterion TX62 wireless module - Cellular connectivity and positioning support - Embedded IPv4 and IPv6 TCP/IP stack access @@ -125,6 +126,7 @@ The **Arduino® Portenta Cat. M1/NB IoT GNSS Shield** provide access to various ### Positioning Four major GNSS systems are supported by the **Arduino® Portenta Cat. M1/NB IoT GNSS Shield**. NMEA protocol is used for transmission of GNSS information. An active antenna can be connected via the micro UFL connector (J8) and has a bias voltage of 3.0V. **Note:** GNSS and cellular services cannot be used simultaneously. + ### Power Tree ![Portenta Cat. M1/NB IoT GNSS Shield Power Tree](assets/thalesShieldPowerTree.svg) Power to the **Arduino® Portenta Cat. M1/NB IoT GNSS Shield** is provided by the host Portenta board via the high density connector. A 3.0V voltage is provided via TC1185-3.0VCT713 (U8) for the active GNSS antenna. @@ -229,7 +231,6 @@ Hereby, Arduino S.r.l. declares that this product is in compliance with essentia ## Company Information - | Company name | Arduino S.r.l | | --------------- | ------------------------------------------ | | Company Address | Via Andrea Appiani, 25 20900 MONZA (Italy) | From 6f88b79f2db667f333edd1f9b92c50582f58ac0a Mon Sep 17 00:00:00 2001 From: Sebastian Romero Date: Fri, 4 Feb 2022 16:30:18 +0100 Subject: [PATCH 4/4] Update dependency --- package-lock.json | 12 ++++++------ package.json | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/package-lock.json b/package-lock.json index 87322e5663..8bcb7a9993 100644 --- a/package-lock.json +++ b/package-lock.json @@ -170,9 +170,9 @@ } }, "@arduino/docs-arduino-cc": { - "version": "1.0.13", - "resolved": "https://npm.pkg.github.com/download/@arduino/docs-arduino-cc/1.0.13/e1750a950f7cb52d930520e70ab6ababe9ba77c0edb37c36ed7d4c0f2cc3fcd5", - "integrity": "sha512-PRRp1sZoj89iFoK1Wm8DOK6aqWNS3llL36hvoQ4E1tNiiZOfD8dpRLNnN6sEiF6hMNjMzUNmKXtAjIiN1iqwkQ==", + "version": "1.0.14", + "resolved": "https://npm.pkg.github.com/download/@arduino/docs-arduino-cc/1.0.14/43225fa4dc9a2247fdd9ed03429557d844bcfbabdec554c5462b9602d18397c6", + "integrity": "sha512-039GGyx64KMPTShopzkXZpDF1lvEN9QfxrZwqZUnV6PIsIuOdshzUoHZqTv62PavlcxfU9S9otF7+T8qvIw6Eg==", "requires": { "@algolia/autocomplete-core": "^1.4.1", "@algolia/autocomplete-preset-algolia": "^1.4.1", @@ -2475,9 +2475,9 @@ "integrity": "sha512-cz8HFjOFfUBtvN+NXYSFMHYRdxZMaEl0XypVrhzxBgadKIXhIkRd8aMeHhmF56Sl7SuS8OnUpQ73/k9LE4VnLg==" }, "@jridgewell/trace-mapping": { - "version": "0.2.5", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.2.5.tgz", - "integrity": "sha512-K+Eths78fXDFOvQ2hgJhCiI5s+g81r2yXmACBpbn+f2+Qt94PNoTgUcAXPT8DZkhXCsZRsHVWVtY5KIBMcpDqQ==", + "version": "0.2.6", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.2.6.tgz", + "integrity": "sha512-rVJf5dSMEBxnDEwtAT5x8+p6tZ+xU6Ocm+cR1MYL2gMsRi4MMzVf9Pvq6JaxIsEeKAyYmo2U+yPQN4QfdTfFnA==", "requires": { "@jridgewell/resolve-uri": "^3.0.3", "sourcemap-codec": "1.4.8" diff --git a/package.json b/package.json index d6841e8551..e40d38c6b3 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ }, "homepage": "https://github.com/arduino/docs-content#readme", "dependencies": { - "@arduino/docs-arduino-cc": "^1.0.13", + "@arduino/docs-arduino-cc": "^1.0.14", "gatsby": "^4.3.0" }, "volta": {