Merge branch 'main' into canchebagur/c33-micropython-tutorial

Author: jcarolinares

.github/actions/cloudflare-upload/action.yml

@@ -0,0 +1,81 @@
+name: "Upload an app to Cloudflare Pages"
+description: "Manually deploy an app to cloudflare pages"
+inputs:
+  upload-dir:
+    description: "The name of the app to build and export"
+    required: true
+  
+  project-name:
+    description: "The name of the project to upload to"
+    required: true
+
+  cloudflare-account:
+    description: "The Cloudflare account ID"
+    required: true
+
+  cloudflare-api-token:
+    description: "The Cloudflare API token"
+    required: true
+
+runs:
+  using: composite
+  steps:
+
+    - name: Find PR Preview Comment
+      if: github.event_name == 'pull_request'
+      uses: peter-evans/find-comment@v1
+      id: deploy-preview-comment
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        comment-author: "github-actions[bot]"
+        body-includes: ${{ inputs.project-name }}
+
+    - name: Update Comment if exists
+      if: github.event_name == 'pull_request' && steps.deploy-preview-comment.outputs.comment-id != 0
+      uses: peter-evans/create-or-update-comment@v1.4.5
+      with:
+        comment-id: ${{ steps.deploy-preview-comment.outputs.comment-id }}
+        edit-mode: replace
+        body: |
+          ### ${{ inputs.project-name }}
+          Waiting for deployment to complete...
+
+    - id: branch-name
+      uses: tj-actions/branch-names@v5
+
+    - id: format-branch
+      shell: bash
+      run: format=$(echo ${{ steps.branch-name.outputs.current_branch }} | tr / -) && echo "::set-output name=branch::$(echo "${format:0:28}")"
+
+    - name: deploy-cloudflare
+      uses: cloudflare/pages-action@v1
+      id: deploy-cloudflare
+      with:
+        apiToken: ${{ inputs.cloudflare-api-token }}
+        accountId: ${{ inputs.cloudflare-account }}
+        projectName: ${{ inputs.project-name }}
+        directory: ${{ inputs.upload-dir }}
+        branch: ${{ steps.format-branch.outputs.branch }}
+
+    - name: Create PR Preview Comment
+      if: github.event_name == 'pull_request' && steps.deploy-preview-comment.outputs.comment-id == 0
+      uses: peter-evans/create-or-update-comment@v1.4.5
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        body: |
+          ### ${{ inputs.project-name }}
+          🚀 Preview this PR: ${{ steps.deploy-cloudflare.outputs.url }}
+          📍 Commit SHA: ${{ github.sha }}
+          
+
+    - name: Update PR Preview Comment
+      if: github.event_name == 'pull_request' && steps.deploy-preview-comment.outputs.comment-id != 0
+      uses: peter-evans/create-or-update-comment@v1.4.5
+      with:
+        comment-id: ${{ steps.deploy-preview-comment.outputs.comment-id }}
+        edit-mode: replace
+        body: |
+          ### ${{ inputs.project-name }}
+          🚀 Preview this PR: ${{ steps.deploy-cloudflare.outputs.url }}
+          📍 Commit SHA: ${{ github.sha }}
+

.github/workflows/cloudflare.yml

@@ -0,0 +1,62 @@
+name: Cloudflare Pages
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    env:
+      REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
+      APP_ENV: prod
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          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@v3
+        id: gatsby-cache-folder
+        with:
+          path: .cache
+          key: ${{ runner.os }}-cache-gatsbyV2-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-cache-gatsbyV2-
+
+      - name: Gatsby Public Folder
+        uses: actions/cache@v3
+        id: gatsby-public-folder
+        with:
+          path: public/
+          key: ${{ runner.os }}-public-gatsbyV2-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-public-gatsbyV2-
+
+      - run: npm install
+      - run: npm run build
+
+      - name: Docs
+        uses: ./.github/actions/cloudflare-upload
+        with:
+          upload-dir: public
+          project-name: docs-content
+          cloudflare-api-token: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          cloudflare-account: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}

.github/workflows/deploy-prd.yml

@@ -18,15 +18,15 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
           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: | 
+        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/ \;

.github/workflows/deploy-stg.yml

@@ -17,15 +17,15 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
           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: | 
+        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/ \;

.github/workflows/render-datasheets.yaml

@@ -10,10 +10,10 @@ jobs:
       REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
           cache: "npm"
           cache-dependency-path: "**/package-lock.json"
 

.npmrc

@@ -1,4 +1,5 @@
 @bcmi-labs:registry=https://npm.pkg.github.com/
 @serjlee:registry=https://npm.pkg.github.com/
 @arduino:registry=https://npm.pkg.github.com/
-//npm.pkg.github.com/:_authToken=${REPO_ACCESS_TOKEN}
+//npm.pkg.github.com/:_authToken=${REPO_ACCESS_TOKEN}
+legacy-peer-deps=true

README.md

@@ -8,55 +8,47 @@ The production website is available at: <https://docs.arduino.cc>
 
 ## How Can I Contribute?
 
-Contributing by creating content or suggestion changes to existing content can be done by making **pull requests**.
+Contributing by creating content or suggesting changes to existing content can be done by making **pull requests**.
 
-You start by forking the repository or by creating a new branch if you have write access to this repo. Create a new branch based on main and name it according to what you will create prefixed with your github username and a slash (e.g. `sebromero/wifi-tutorial`). Read in the section below how to add different types of new content.
+You start by forking the repository or by creating a new branch if you have write access to this repo. Create a new branch based on main and name it according to what you will create prefixed with your GitHub username and a slash (e.g. `sebromero/wifi-tutorial`). Read in the section below how to add different types of new content.
 
-When you're done with a draft you can create a pull request. This will give the content team the possibility to review it and leave comments or request changes. During this review process you can continue to push commits to the same branch. They will show up in the pull request automatically.
+When you're done with a draft you can create a pull request. This will give the content team the possibility to review it and leave comments or request changes. During this review process, you can continue to push commits to the same branch. They will show up in the pull request automatically.
 
-Once the pull request gests approved and merged into main, the content will be deployed to the live server.
-
-There are four different content types you can contribute with. These are **tutorial**, **article**, **how to** and **project**. Please read more on what they mean and how to write one in the [Contribution Templates folder](/contribution-templates/README.md).
-
-|Content|Description|Example|
-|-------|-----------|-------|
-|Tutorial|Learn how to do something.|[Control Built-in RGB LED over Wi-Fi with Nano RP2040 Connect](https://docs.arduino.cc/tutorials/nano-rp2040-connect/rp2040-web-server-rgb)|
-|Article|Learn about a specific topic.|[Multimeter Basics](https://docs.arduino.cc/learn/electronics/multimeter-basics)|
-|How To|Smaller tutorial with less information and more straight to the example.|[Analog Read Serial](https://docs.arduino.cc/built-in-examples/basics/AnalogReadSerial)|
-|Project|Learn how to build something.|[Plant Communicator with MKR WiFi 1010](https://projecthub.arduino.cc/Arduino_Genuino/plant-communicator-with-mkr-wifi-1010-081cf5)|
+Once the pull request gets approved and merged into main, the content will be deployed to the live server.
 
 ## Fixing Bugs and Typos
 
-If you found a mistake in the content you need to locate the corresponding file to fix it and create a pull request. Here is how to locate the content.
+If you find a mistake in the content, you need to locate the corresponding file to fix it and create a pull request. Here is how to locate the content.
 
 ### Products
 
-- If you found an issue in a hardware product-specific tutorial they are located according to the following pattern:
+- If you have found an issue in a hardware product-specific tutorial they are located according to the following pattern:
   `/content/hardware/[product-family]/[product-type]/[product]/tutorials/[tutorial-name]/[content-file].md`
 
-- If you found an issue in a hardware product's datasheet they are located according to the following pattern:
+- If you have found an issue in a hardware product's datasheet they are located according to the following pattern:
   `/content/hardware/[product-family]/[product-type]/[product]/datasheet/datasheet.md`
 
-- If you found an issue in a hardware product's description they are located according to the following pattern:
+- If you have found an issue in a hardware product's description they are located according to the following pattern:
   `/content/hardware/[product-family]/[product-type]/[product]/product.md`
 
-- If you found an issue in a hardware product's tech specs table they are located according to the following pattern:
+- If you have found an issue in a hardware product's tech specs table they are located according to the following pattern:
   `/content/hardware/[product-family]/[product-type]/[product]/tech-specs.yml`
 
-- If you found an issue in a hardware product's features they are located according to the following pattern:
+- If you have found an issue in a hardware product's features they are located according to the following pattern:
   `/content/hardware/[product-family]/[product-type]/[product]/features.md`
 
 ### Software
 
-- If you found an issue in a software product's tutorial they are located according to the following pattern:
+- If you have found an issue in a software product's tutorial they are located according to the following pattern:
   `/content/software/[product-name]/tutorials/(tutorial-subfolder)/[tutorial-name]/[content-file].md`
 
 ## Adding Content
 
 ### Referencing Content From Other Folders
 
-The build system supports symlinks. This allows to include content in multiple places. For example, if there is a tutorial that works for different boards, it can be written once and included in different places. On Unix the `ln` command can be used for that.
-For example, if we want a tutorial that lives here `content/tutorials/generic/basic-servo-control` to show up on the Nano 33 BLE product page, we can link it as follows. First open a shell and navigate to the tutorials folder of the product. e.g. `cd content/hardware/03.nano/boards/nano-33-ble/tutorials/`. Then create a symlink with a relative path to the tutorial. e.g. `ln -s ../../../../../tutorials/generic/basic-servo-control basic-servo-control`. This will create a symbolic link to that directory without duplicating it. Any change can be made in either location. They will be applied the original source file in both cases.
+The build system supports symlinks. This allows the inclusion of content in multiple places. For example, if there is a tutorial that works for different boards, it can be written once and included in different places. On Unix the `ln` command can be used for that.
+
+For example, if we want a tutorial that lives here `content/tutorials/generic/basic-servo-control` to show up on the Nano 33 BLE product page, we can link it as follows. First, open a shell and navigate to the tutorials folder of the product. e.g. `cd content/hardware/03.nano/boards/nano-33-ble/tutorials/`. Then create a symlink with a relative path to the tutorial. e.g. `ln -s ../../../../../tutorials/generic/basic-servo-control basic-servo-control`. This will create a symbolic link to that directory without duplicating it. Any change can be made in either location. They will be applied to the source file in both cases.
 
 #### Adding Symlinks on Windows
 
@@ -83,27 +75,29 @@ 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
 ```
 
-### Including Code Blocks fetching Github pages
+### Including Code Blocks fetching GitHub pages
 
 CodeBlocks are custom components that can be added directly in the Markdown on docs-content.
-Using this component, the code block will be fetched directly from Github pages.
+
+Using this component, the code block will be fetched directly from GitHub pages.
 
 Syntax:
+
 ` <CodeBlock url=”https://github.com/example” className="{language}"/>`
- 
-Broken URL will show error alert. URL must be in Github domain and must be public.
+
+Broken URLs will show an error alert. URL must be in the GitHub domain and must be public.
 
 ## Previewing Changes
 
 Whenever you create a Pull Request (PR) GatsbyCloud will create a preview deployment in which you can see how your changes look when rendered on the website. The link to the preview will appear in the comments of the PR. This also works with Draft PRs, but not for PRs created from a fork.
 
 ## License
 
-![](https://i.creativecommons.org/l/by-sa/3.0/88x31.png) 
+![](https://i.creativecommons.org/l/by-sa/3.0/88x31.png)
 
 Please note that your contribution to the Arduino Documentation is licensed under a Creative Commons Attribution-Share Alike 4.0 License. see https://creativecommons.org/licenses/by-sa/4.0/
-