Skip to content

Commit

Permalink
Merge pull request #80 from reubenmiller/chore-update-docusaurus
Browse files Browse the repository at this point in the history
chore: update to docusaurus 3.4
  • Loading branch information
reubenmiller authored Jul 17, 2024
2 parents 6df4e46 + 19ba85a commit d5a9f49
Show file tree
Hide file tree
Showing 5 changed files with 1,600 additions and 641 deletions.
15 changes: 7 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,11 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "^3.1.0",
"@docusaurus/plugin-client-redirects": "^3.1.0",
"@docusaurus/preset-classic": "^3.1.0",
"@docusaurus/theme-mermaid": "^3.1.0",
"@docusaurus/core": "^3.4.0",
"@docusaurus/plugin-client-redirects": "^3.4.0",
"@docusaurus/preset-classic": "^3.4.0",
"@docusaurus/theme-mermaid": "^3.4.0",
"@mdx-js/react": "^3.0.0",
"@uidotdev/usehooks": "^2.4.1",
"clsx": "^1.2.1",
"default-passive-events": "^2.0.0",
"docusaurus-remark-plugin-tab-blocks": "^3.0.0",
Expand All @@ -34,9 +33,9 @@
"usehooks-ts": "^3.1.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.1.0",
"@docusaurus/tsconfig": "^3.1.0",
"@docusaurus/types": "^3.1.0",
"@docusaurus/module-type-aliases": "^3.4.0",
"@docusaurus/tsconfig": "^3.4.0",
"@docusaurus/types": "^3.4.0",
"@types/mdast": "^4.0.3",
"@types/react": "^18.2.48",
"@types/shell-quote": "^1.7.5",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ There are different ways to install the docker engine on MacOS, however this gui
If you are using Windows, it is recommended to use WSL2 to run your a Ubuntu distribution where `docker-ce` is installed within it. Please do not bother with Docker Desktop or any other "Desktop" related product (e.g. `Rancher Desktop`). It will save you a lot of hassle by using the native `docker-ce` version inside the WSL2 distribution itself.
Once you have a Ubuntu distribution running under WSL2, follow the instructions under the [Linux installation](#Linux) section.
Once you have a Ubuntu distribution running under WSL2, follow the instructions under the [Linux installation](#linux) section.
### Linux
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-0.13.1/references/domain-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ That includes:
* allows monitoring the health of devices
* helps troubleshooting when problems with the device are reported

[^1]: more details see appendix [Device Domain](#device-domain)
[^1]: more details see appendix [Device Domain](#device-overview)

## Child-Devices

Expand Down Expand Up @@ -172,7 +172,7 @@ A **plugin** defines and implements a specific **contract** for all interactions

# Appendix

## Device Overview
## Device Overview {#device-overview}

**thin-edge** is designed to facilitate IoT functionality to resource constrained **devices**. The focus is on industrial OT **devices** or any other kind of embedded **devices**. It is not reduced to **devices** that are capable to install and run thin-edge, but includes also **devices** that need another _(gateway) device_ aside, that executes **thin-edge**.

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-0.13.1/start/connect-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ To create a new policy, head over to the AWS IoT Core and navigate to

**Security → Policies → Create policy → Policy properties → Policy name → Enter the name of your policy (e.g.tedge)**

On the Policy statements tab click on ***JSON*** and enter the policy in the ***Policy document*** (an example policy can be found [here](./aws-example-policy.json)) then click ***Create***.
On the Policy statements tab click on ***JSON*** and enter the policy in the ***Policy document*** (an example policy can be found [here](https://raw.githubusercontent.com/thin-edge/thin-edge.io/main/docs/src/start/aws-example-policy.json)) then click ***Create***.

In the AWS IoT Core, navigate to ***Manage → All devices → Things → Create things → Create Single thing → Next***. Enter the Thing name which can be obtained from the device with the output of the following command:

Expand Down
Loading

0 comments on commit d5a9f49

Please sign in to comment.