Merge branch 'main' into h7_link_fix

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/[email protected]
+      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/[email protected]
+      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/[email protected]
+      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/ \;

.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

@@ -83,6 +83,7 @@ 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
 ```
@@ -94,16 +95,24 @@ 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.
 
+### Use Custom content con various component
+
+- **Details** pages: on every `product.md` file you have to create 4 variables, related to the hero buttons component in every details page:
+  - primary_button_url: (string)
+  - primary_button_title: (string)
+  - secondary_button_url: (string)
+  - secondary_button_title: (string)
+- **Video**: You can manage the content in the video components (Actually in Learn, Arduino-cloud and MycroPython page), just compiling the file `videoInfo.md` in the main directory of the relative section.
+
 ## 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/
-