Merge pull request #39 from arduino/sebromero/datasheet-fix

Better error handling when rendering datasheets

Author: sebromero

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) |

package-lock.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": {

package.json

@@ -19,4 +19,7 @@ validateMetadata: true
 verbose: true
 
 # Allows to debug the rules by outputting process messages
-debug: false
+debug: false
+
+# Defines rules for what links not to check. Usually relative links should not be checked.
+brokenLinkExcludePatterns: [^./, ^../, ^#, ^chrome://, localhost , ^assets/, ^images/]

scripts/validation/config/config-generic.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/]

scripts/validation/config/config-tutorials.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: "(?<!\\/|-)\\b(master|slave)\\b"
   regexModifiers: "gi"
   shouldMatch: false

scripts/validation/rules/rules-spelling.yml

@@ -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