Skip to content

Better error handling when rendering datasheets #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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) |
Expand Down
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
5 changes: 4 additions & 1 deletion scripts/validation/config/config-generic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/]
1 change: 0 additions & 1 deletion scripts/validation/config/config-tutorials.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/]
6 changes: 0 additions & 6 deletions scripts/validation/rules/rules-spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 1 addition & 4 deletions scripts/validation/validate.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

Expand All @@ -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
Expand Down