Hello world

Author: Serjlee

.github/workflows/deploy-stg.yml

@@ -0,0 +1,60 @@
+name: Deploy to docs.oniudra.cc
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - ghaction
+
+jobs:
+  build:
+    if: "github.repository == 'arduino/docs-content'"
+    runs-on: ubuntu-latest
+    env:
+      REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
+      APP_ENV: staging
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          cache: "npm"
+          cache-dependency-path: "**/package-lock.json"
+
+      - name: Gatsby main cache
+        uses: actions/cache@v1
+        id: gatsby-cache-folder
+        with:
+          path: .cache
+          key: ${{ runner.os }}-cache-gatsby-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-cache-gatsby-
+
+      - name: Gatsby Public Folder
+        uses: actions/cache@v1
+        id: gatsby-public-folder
+        with:
+          path: public/
+          key: ${{ runner.os }}-public-gatsby-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-public-gatsby-
+
+      - run: npm install
+
+      - run: npm run build
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.STAG_AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.STAG_AWS_SECRET_ACCESS_KEY }}
+          aws-region: us-west-1
+
+      - name: Sync all cacheable assets
+        run:
+          aws s3 sync --cache-control "public, max-age=31536000, immutable" --include "*.css" --include="*.js" --include="*.gif" --include="*.png" --include="*.svg" --exclude "*.html" --exclude="sw.js" --exclude="*.json" --delete public/ s3://${{ secrets.STAG_AWS_S3_BUCKET_NAME }}/
+          # Don't cache any HTML or JSON file: they should always be up-to-date
+      - name: Sync all non-cacheable assets
+        run: aws s3 sync --cache-control "public, max-age=0, must-revalidate" --include "*.html" --include="sw.js" --include="*.json" --include "*.css" --exclude="*.js" --exclude="*.gif" --exclude="*.png" --exclude="*.svg" --delete public/ s3://${{ secrets.STAG_AWS_S3_BUCKET_NAME }}/

.github/workflows/sync-private-mirror.yml

@@ -0,0 +1,25 @@
+name: Sync private mirror
+on:
+  push:
+    branches:
+      - main
+jobs:
+  repo-sync:
+    if: "github.repository == 'arduino/docs-content'"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: "0"
+          ref: "main"
+      - name: Install SSH key
+        uses: shimataro/ssh-key-action@v2
+        with:
+          key: ${{ secrets.DOCS_PRIVATE_SSH_KEY }}
+          known_hosts: unnecessary
+      - run: |
+          git remote add mirror git@github.com:arduino/docs-content-private.git
+          git config --global user.email "sync@docs-content-private"
+          git config --global user.name "docs-sync"
+          git checkout main
+          git push -u mirror main

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

@@ -0,0 +1,39 @@
+name: Sync pull request from private repository
+on:
+  workflow_dispatch:
+
+jobs:
+  repo-sync:
+    if: "github.repository == 'arduino/docs-content-private'"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: "0"
+
+      - name: Install SSH key
+        uses: shimataro/ssh-key-action@v2
+        with:
+          key: ${{ secrets.DOCS_PRIVATE_SSH_KEY }}
+          known_hosts: unnecessary
+
+      - name: Sync branch
+        run: |
+          git remote add mirror git@github.com:arduino/docs-content.git
+          git config --global user.email "sync@docs-content-private"
+          git config --global user.name "docs-sync"
+          git checkout -b sync/${GITHUB_REF_NAME}
+          git push -u mirror sync/${GITHUB_REF_NAME}
+
+      - 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)" --repo arduino/docs-content
+
+      - name: Close PR
+        env:
+          GITHUB_TOKEN: ${{ secrets.SYNC_GITHUB_CLI_TOKEN }}
+        run: gh pr close $GITHUB_REF_NAME
+
+      - name: Delete branch
+        run: git push origin :${GITHUB_REF_NAME}

.gitignore

@@ -0,0 +1,10 @@
+.babelrc
+.cache
+_templates
+algolia-queries.js
+envs
+gatsby-*
+node_modules
+public
+scripts
+src

.npmrc

@@ -0,0 +1,4 @@
+@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}

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing to Arduino Documentation
+
+The docs.arduino.cc website is built from the Markdown sources hosted in this repository.
+
+## How to Contribute
+
+In order to contribute new or updated documentation, you must first create a GitHub account and fork the original repository to your own account. You can make changes, save them in your repository, then [make a pull request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) against this repository. The pull request will appear [in the repository](https://github.com/arduino/docs.arduino.cc/pulls) where it can be assessed by the maintainers, copy edited, and if appropriate, merged.
+
+**NOTE:** Unless you are opening a pull request which will only make small corrections, for instance to correct a typo, you are more likely to get traction for your changes if you [open an issue](https://github.com/arduino/docs.arduino.cc/issues) first to discuss the proposed changes.
+
+**NOTE:** The default [branch](https://github.com/arduino/docs.arduino.cc/branches) of the repository is the `develop` branch, and this should be the branch you get by default when you initially checkout the repository. You should target any pull requests against the `develop` branch, pull requests against the `master` branch will automatically fail checks and not be accepted.
+
+## Type of Content
+
+We welcome contributions from the community, ranging from correcting small typos all the way through to adding entire new sections to the documentation. However, we are looking to keep the contents of this repository focussed on Arduino-specific things.
+
+Contributions that are more likely to be accepted:
+
+* Corrections of typos, broken links, wrong information
+* New tutorials showing how to use features of Arduino hardware products
+* Improvements to existing articles to clarify unclear concepts or add useful bits of information
+
+Contributions that are more likely to be rejected:
+
+* Generic project tutorials ([Project Hub](https://create.arduino.cc/projecthub) is the place for them)
+* Duplicates of existing content
+* Content that is specific to third-party services or products
+
+## Style
+
+We require content to be written in plain and concise language, so that both basic and advanced users can understand it. See our [Style Guide](https://www.arduino.cc/en/Reference/StyleGuide) for more information about this.
+
+## Licensing 
+
+The documentation is under a [Creative Commons Attribution-Sharealike](https://creativecommons.org/licenses/by-sa/4.0/) (CC BY-SA 4.0) license, while examples of code are licensed under a [public domain](https://creativecommons.org/share-your-work/public-domain/cc0/) license. By contributing content to this repository you are agreeing to place your contributions under these licenses.

README.md

@@ -0,0 +1,3 @@
+# docs-content
+
+Content for docs.arduino.cc

content/_snippets/hardware/10k-resistor/image.svg

@@ -0,0 +1,3 @@
+---
+title: 10k Ω resistor
+---

content/_snippets/hardware/10k-resistor/product.md

@@ -0,0 +1,3 @@
+---
+title: 220 Ω resistor
+---

content/_snippets/hardware/220ohm-resistor/image.svg

@@ -0,0 +1,3 @@
+---
+title: 4.7k Ω resistor
+---