Merge branch 'main' into x8-python-m4-clarifications

Author: sebromero

.github/workflows/deploy-prd.yml

@@ -22,6 +22,17 @@ jobs:
           cache: "npm"
           cache-dependency-path: "**/package-lock.json"
 
+      - name: Render Datasheets
+        run: cd ${GITHUB_WORKSPACE}/scripts/datasheet-rendering;./render-datasheets.sh
+
+      - name: Copy Static Files
+        run: | 
+          mkdir -p static/resources/datasheets static/resources/schematics static/resources/pinouts
+          find ./content/hardware -type f -name "*-schematics.pdf" -exec cp {} ./static/resources/schematics/ \;
+          find ./content/hardware -type f -name "*-datasheet.pdf" -exec cp {} ./static/resources/datasheets/ \;
+          find ./content/hardware -type f -name "*-full-pinout.pdf" -exec cp {} ./static/resources/pinouts/ \;
+          find ./content/hardware -type f -name "*-pinout.png" -exec cp {} ./static/resources/pinouts/ \;
+
       - name: Gatsby main cache
         uses: actions/cache@v2
         id: gatsby-cache-folder
@@ -41,8 +52,7 @@ jobs:
             ${{ runner.os }}-public-gatsby-
 
       - run: npm install
-
-      - run: GENERATE_DATASHEETS=true npm run build
+      - run: npm run build
 
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v1

.github/workflows/deploy-stg.yml

@@ -20,6 +20,17 @@ jobs:
           node-version: 14
           cache: "npm"
           cache-dependency-path: "**/package-lock.json"
+      
+      - name: Render Datasheets
+        run: cd ${GITHUB_WORKSPACE}/scripts/datasheet-rendering;./render-datasheets.sh
+
+      - name: Copy Static Files
+        run: | 
+          mkdir -p static/resources/datasheets static/resources/schematics static/resources/pinouts
+          find ./content/hardware -type f -name "*-schematics.pdf" -exec cp {} ./static/resources/schematics/ \;
+          find ./content/hardware -type f -name "*-datasheet.pdf" -exec cp {} ./static/resources/datasheets/ \;
+          find ./content/hardware -type f -name "*-full-pinout.pdf" -exec cp {} ./static/resources/pinouts/ \;
+          find ./content/hardware -type f -name "*-pinout.png" -exec cp {} ./static/resources/pinouts/ \;
 
       - name: Gatsby main cache
         uses: actions/cache@v2
@@ -40,8 +51,7 @@ jobs:
             ${{ runner.os }}-public-gatsby-
 
       - run: npm install
-
-      - run: GENERATE_DATASHEETS=true npm run build
+      - run: npm run build
 
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v1

.github/workflows/render-datasheets.yaml

@@ -0,0 +1,23 @@
+name: Render datasheets
+
+on:
+  workflow_dispatch:
+
+jobs:
+  render-datasheets:
+    runs-on: ubuntu-latest
+    env:
+      REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          cache: "npm"
+          cache-dependency-path: "**/package-lock.json"
+
+      - name: Render
+        run: |
+         cd scripts/datasheet-rendering
+         ./render-datasheets.sh

.github/workflows/sync-pull-request.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Sync PR
         env:
           GITHUB_TOKEN: ${{ secrets.SYNC_GITHUB_CLI_TOKEN }}
-        run: gh pr create --title "$(gh pr view $GITHUB_REF_NAME --json title --jq .title)" --body "$(gh pr view $GITHUB_REF_NAME --json body --jq .body)"  --label "$(gh pr view $GITHUB_REF_NAME --json labels --jq .labels[].name)" --reviewer "$(gh pr view $GITHUB_REF_NAME --json reviewRequests --jq .reviewRequests[].login)" --label "arduino" --assignee "$(gh pr view $GITHUB_REF_NAME --json assignees --jq .assignees[].login)" --repo arduino/docs-content
+        run: gh pr create --repo arduino/docs-content --head sync/${GITHUB_REF_NAME} --title "$(gh pr view $GITHUB_REF_NAME --json title --jq .title)" --body "$(gh pr view $GITHUB_REF_NAME --json body --jq .body)"  --label "$(gh pr view $GITHUB_REF_NAME --json labels --jq .labels[].name)" --reviewer "$(gh pr view $GITHUB_REF_NAME --json reviewRequests --jq .reviewRequests[].login)" --label "arduino" --assignee "$(gh pr view $GITHUB_REF_NAME --json assignees --jq .assignees[].login)"
 
       - name: Close PR
         env:

.github/workflows/workflow-validate.yaml

@@ -18,7 +18,7 @@ jobs:
       - name: Run spell check
         run: |
           pip install codespell
-          codespell -I "scripts/resources/spell-check-ignore-list.txt" --skip="*.svg,*.dxf" ./content/
+          codespell -I "scripts/resources/spell-check-ignore-list.txt" --skip="*.svg,*.dxf,*.pdf" ./content/
 
   lint:
     name: Content Linter

.vscode/tasks.json

@@ -87,7 +87,7 @@
                 "cwd": "${workspaceFolder}${pathSeparator}scripts${pathSeparator}validation"
             },
             "windows": {
-                "command": "node .\\fix-issues.js -p ..\\..\\content\\hardware\\"               
+                "command": "node .\\fix-issues.js -p '..\\..\\content\\hardware\\'"
             },
             "group": "none",
             "presentation": {
@@ -97,14 +97,14 @@
             "problemMatcher": []
         },
         {
-            "label": "Generate all datasheets",
+            "label": "Render all datasheets",
             "type": "shell",
-            "command": "./generate-datasheets.sh",
+            "command": "./render-datasheets.sh",
             "options": {
-                "cwd": "${workspaceFolder}${pathSeparator}scripts${pathSeparator}datasheet-generator"
+                "cwd": "${workspaceFolder}${pathSeparator}scripts${pathSeparator}datasheet-rendering"
             },
             "windows": {
-                "command": ".\\generate-datasheets.cmd"                
+                "command": ".\\render-datasheets.cmd"                
             },
             "group": "none",
             "presentation": {
@@ -114,14 +114,14 @@
             "problemMatcher": []
         },
         {
-            "label": "Generate datasheet (current document)",
+            "label": "Render datasheet (current document)",
             "type": "shell",
-            "command": "./generate-datasheets.sh '../../${relativeFileDirname}'",
+            "command": "./render-datasheets.sh '../../${relativeFileDirname}'",
             "options": {
-                "cwd": "${workspaceFolder}${pathSeparator}scripts${pathSeparator}datasheet-generator"
+                "cwd": "${workspaceFolder}${pathSeparator}scripts${pathSeparator}datasheet-rendering"
             },
             "windows": {
-                "command": ".\\generate-datasheets.cmd '..\\..\\${relativeFileDirname}'"                
+                "command": ".\\render-datasheets.cmd '..\\..\\${relativeFileDirname}'"                
             },
             "group": "none",
             "presentation": {
@@ -133,10 +133,13 @@
         {
             "label": "Run spell check",
             "type": "shell",
-            "command": "(pip install codespell > /dev/null 2>&1 || pip3 install codespell > /dev/null 2>&1) && codespell -I 'scripts${pathSeparator}resources${pathSeparator}spell-check-ignore-list.txt' --skip='*.svg,*.dxf' .${pathSeparator}content${pathSeparator}",
+            "command": "(pip install codespell > /dev/null 2>&1 || pip3 install codespell > /dev/null 2>&1) && codespell -I 'scripts${pathSeparator}resources${pathSeparator}spell-check-ignore-list.txt' --skip='*.svg,*.dxf,*.pdf' .${pathSeparator}content${pathSeparator}",
             "options": {
                 "cwd": "${workspaceFolder}"
             },
+            "windows": {
+                "command": ".\\scripts\\spell-check.cmd"
+            },
             "group": "none",
             "presentation": {
                 "reveal": "always",
@@ -156,10 +159,13 @@
         {
             "label": "Fix misspellings",
             "type": "shell",
-            "command": "(pip install codespell > /dev/null 2>&1 || pip3 install codespell > /dev/null 2>&1) && codespell -w -I 'scripts${pathSeparator}resources${pathSeparator}spell-check-ignore-list.txt' --skip='*.svg,*.dxf' .${pathSeparator}content${pathSeparator}",
+            "command": "(pip install codespell > /dev/null 2>&1 || pip3 install codespell > /dev/null 2>&1) && codespell -w -I 'scripts${pathSeparator}resources${pathSeparator}spell-check-ignore-list.txt' --skip='*.svg,*.dxf,*.pdf' .${pathSeparator}content${pathSeparator}",
             "options": {
                 "cwd": "${workspaceFolder}"
             },
+            "windows": {
+                "command": ".\\scripts\\spell-check-fix.cmd"
+            },
             "group": "none",
             "presentation": {
                 "reveal": "always",
@@ -168,4 +174,4 @@
             "problemMatcher": []
         }
     ]
-  }
+  }

README.md

@@ -83,7 +83,9 @@ symbolic link created for AnalogInput <<===>> ..\..\..\..\..\built-in-examples\0
 ### Including Code Snippets
 
 Code snippets can be included by using the triple backticks syntax e.g. ` ```arduino` followed by the code and three closing backticks. The following syntaxes are supported:
+```
 arduino, bash, markup, clike, c, cpp, css, css-extras, javascript, jsx, js-extras, coffeescript, diff, git, go, graphql, handlebars, json, less, makefile, markdown, objectivec, ocaml, python, reason, sass, scss, sql, stylus, tsx, typescript, wasm, yaml
+```
 
 
 ## Previewing Changes

content/arduino-cloud/01.getting-started/01.iot-cloud-getting-started/assets/ethernet.png

@@ -1,7 +1,7 @@
 ---
 title: "Getting Started With the Arduino IoT Cloud"
 compatible-products: [mkr-1000-wifi, mkr-wifi-1010, nano-33-iot, nano-rp2040-connect]
-difficulty: easy
+difficulty: beginner
 description: 'The Arduino IoT Cloud is a online platform that makes it easy for you to create, deploy and monitor IoT projects.'
 tags:
   - IoT Cloud
@@ -59,8 +59,11 @@ The following boards connect to the Arduino IoT Cloud via Wi-Fi.
 - [Nano 33 IoT](https://store.arduino.cc/arduino-nano-33-iot)
 - [Portenta H7](https://store.arduino.cc/portenta-h7)
 - [Portenta H7 Lite Connected](https://store.arduino.cc/products/portenta-h7-lite-connected)
+- [Portenta Machine Control](https://store.arduino.cc/products/arduino-portenta-machine-control)
 - [Nicla Vision](https://store.arduino.cc/products/nicla-vision)
+- [Opta](https://docs.arduino.cc/hardware/opta).\* 
 
+\* The Opta is scheduled to be released soon, along with documentation how to use it. Read more at the [Opta communications page](https://store.arduino.cc/pages/opta).
 
 Connection via Wi-Fi is an easy alternative, and your credentials can safely be entered during the configuration of a project. This type of connection is most suitable for low-range projects, where you connect your board to the cloud via your home/work/school router.
 
@@ -96,6 +99,24 @@ The Arduino IoT Cloud supports a wide range of third party boards based on the E
 
 ***To learn more about ESP32/ESP8266 support and how to set it up, visit the [Connecting ESP32 & ESP8266 to Arduino Cloud IoT](/cloud/iot-cloud/tutorials/esp-32-cloud) guide.***
 
+### Ethernet
+
+The Arduino IoT Cloud supports connection via Ethernet on a number of devices. The options to connect via Ethernet are the following:
+- Connect with the [Portenta H7](https://store.arduino.cc/products/portenta-h7) in combination with an Ethernet compatible carrier/shield (see below).
+- Connect with the [Opta](https://docs.arduino.cc/hardware/opta).\* 
+
+\* The Opta is scheduled to be released soon, along with documentation how to use it. Read more at the [Opta communications page](https://store.arduino.cc/pages/opta).
+
+To connect with the **Portenta H7** board, you will need one of the following shields/carriers:
+- [Portenta Vision Shield Ethernet](https://store.arduino.cc/products/arduino-portenta-vision-shield-ethernet)
+- [Portenta Machine Control](https://store.arduino.cc/portenta-machine-control)
+
+To enable communication via Ethernet with the Portenta H7, while configuring your device, you need to select the "Ethernet" option. If your device is already configured as a Wi-Fi device, you need to remove it before configuring it to Ethernet communication.
+
+![Choose the Ethernet option.](assets/ethernet.png)
+
+***Please note that older hardware such as the [Ethernet Shield Rev2](https://store.arduino.cc/products/arduino-ethernet-shield-2) and [MKR ETH Shield](https://store.arduino.cc/products/arduino-mkr-eth-shield) are currently not supported by the Arduino IoT Cloud.***
+
 ## Support
 
 If you have any problems with the Arduino IoT Cloud, you can browse through common troubleshooting issues and find information on different features in the **Arduino Help Center**. If you don’t find the answer you are looking for, we are always happy to help you with any question regarding our products!