Added new installation guide #59
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the OpenRemote documentation by adding a new installation guide, improving the code block theme, and introducing a reusable card component for documentation purposes.
- Added a new 'How to install' category to the docs sidebar.
- Updated the Docusaurus config with custom prism themes for better code syntax highlighting.
- Introduced a CardElement React component for clickable documentation cards.
Reviewed Changes
Copilot reviewed 14 out of 21 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sidebars.ts | Added a new documentation category for installation guidance. |
| docusaurus.config.ts | Updated prism themes for code blocks in both dark and light modes. |
| docs/util/card-element.jsx | Added a CardElement component for clickable card elements. |
Files not reviewed (7)
- docs/how-to-install/styles.module.css: Language not supported
- docs/how-to-install/using-aws-marketplace.mdx: Language not supported
- docs/how-to-install/using-docker.mdx: Language not supported
- docs/how-to-install/using-kubernetes.mdx: Language not supported
- docs/how-to-install/using-openremote-cli.mdx: Language not supported
- docs/util/util.module.css: Language not supported
- src/css/styles.css: Language not supported
| {children?.length ? children[0] : children} | ||
| </div> | ||
| {children?.length && |
There was a problem hiding this comment.
The conditional check 'children?.length' returns true for string values, causing children[0] to extract only the first character instead of the entire string. Consider using Array.isArray(children) to differentiate between an array of elements and a single string.
| {children?.length ? children[0] : children} | |
| </div> | |
| {children?.length && | |
| {Array.isArray(children) ? children[0] : children} | |
| </div> | |
| {Array.isArray(children) && |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
There was a problem hiding this comment.
I was using children?.length intentionally here.
This condition statement covers both undefined objects and an empty array.
However, I'm not sure whether this is the best solution.
Is this code OK for you?
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the OpenRemote documentation by adding a new installation guide using Docker, a custom clickable card React component, and improvements to the code block theme.
- Added a new sidebar category for installation guides.
- Updated Docusaurus configuration to use new Prism themes.
- Introduced a new CardElement React component for clickable card elements.
Reviewed Changes
Copilot reviewed 14 out of 21 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sidebars.ts | Added a new category for "How to install" documentation. |
| docusaurus.config.ts | Integrated custom Prism themes for code block styling. |
| docs/util/card-element.jsx | Created a new React component for clickable card elements. |
Files not reviewed (7)
- docs/how-to-install/styles.module.css: Language not supported
- docs/how-to-install/using-aws-marketplace.mdx: Language not supported
- docs/how-to-install/using-docker.mdx: Language not supported
- docs/how-to-install/using-kubernetes.mdx: Language not supported
- docs/how-to-install/using-openremote-cli.mdx: Language not supported
- docs/util/util.module.css: Language not supported
- src/css/styles.css: Language not supported
| {children?.length ? children[0] : children} | ||
| </div> | ||
| {children?.length && |
There was a problem hiding this comment.
Using children?.length to decide whether to index into children may lead to unintended behavior if children is a string (since strings have a length property). Consider using Array.isArray(children) to ensure children is an array before accessing its elements.
| {children?.length ? children[0] : children} | |
| </div> | |
| {children?.length && | |
| {Array.isArray(children) && children.length > 0 ? children[0] : children} | |
| </div> | |
| {Array.isArray(children) && children.length > 1 && |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
Description
I've added more documentation on the installation for OpenRemote using Docker.
My motivation was the amount of people asking for help on setting up custom OpenRemote installations.
The goal is to simplify the setup process for configurations other than the demo setup.
I'll add some screenshots later.
Changelog;
It contains guides for setting up the demo, deploying an production instance, or how to deploy a custom project.
I utilized the Docusaurus tab component to make this possible