Split FAQ

Jesus7502 · Nov 2, 2019 · 8422374 · 8422374
1 parent 58b5c87
commit 8422374
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 59 deletions.
diff --git a/documentation/faq.md b/documentation/faq.md
diff --git a/documentation/faq/hassio_only.md b/documentation/faq/hassio_only.md
@@ -0,0 +1,10 @@
+---
+id: hassio_only
+title: Is this for hass.io only?
+---
+
+No, it's not.
+
+You can use this on _any_ Home Assistant installation.
+
+_Windows might have issues, but if you are running HA on Windows you are probably used to that._
diff --git a/documentation/faq/highlights.md b/documentation/faq/highlights.md
@@ -0,0 +1,8 @@
+---
+id: highlights
+title: Highlights of what HACS can do
+---
+
+- Help you discover new custom elements.
+- Help you install (download) new custom elements.
+- Help you keep track of your custom elements.
diff --git a/documentation/faq/installation.md b/documentation/faq/installation.md
@@ -0,0 +1,10 @@
+---
+id: installation
+title: "How does it work: Installation"
+---
+When you install an element this is what's happening:
+
+1. The local target directory(folder) is deleted.
+1. A new local target directory is created.
+1. All expected files are downloaded to that directory.
+1. The files it downloads depends on the type.
diff --git a/documentation/faq/limitations.md b/documentation/faq/limitations.md
@@ -0,0 +1,5 @@
+---
+id: limitations
+title: Known limitations
+---
+- If you install/upgrade/remove or add a custom repository while the background task is running, do **not** restart Home Assistant until that task is done, if you do your action will not be saved.
diff --git a/documentation/faq/upgrade.md b/documentation/faq/upgrade.md
@@ -0,0 +1,5 @@
+---
+id: upgrade
+title: "How does it work: Upgrade"
+---
+The same as installation.
diff --git a/documentation/faq/what.md b/documentation/faq/what.md
@@ -0,0 +1,6 @@
+---
+id: what
+title: What is HACS?
+---
+
+_Currently I have no idea what to write her..._
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -27,12 +27,8 @@ module.exports = {
  { to: 'docs/configuration/start', label: 'Configuration', position: 'left' },
  { to: 'docs/basic/getting_started', label: 'Usage', position: 'left' },
  { to: 'docs/developer/start', label: 'Developer docs', position: 'right' },
+ { to: 'docs/faq/what', label: 'FAQ', position: 'right' },
  { to: 'help', label: 'Help', position: 'right' },
- {
- href: 'https://github.com/custom-components/hacs',
- label: 'GitHub',
- position: 'right',
- },
  ],
  },
  },

diff --git a/sidebars.js b/sidebars.js
@@ -71,5 +71,15 @@ module.exports = {
  "publish/include",
  "publish/blacklist"
  ]
+ },
+ "FAQ": {
+ "FAQ": [
+ "faq/what",
+ "faq/highlights",
+ "faq/hassio_only",
+ "faq/installation",
+ "faq/upgrade",
+ "faq/limitations"
+ ]
  }
 };
diff --git a/src/pages/help.js b/src/pages/help.js
@@ -47,7 +47,7 @@ const blocks = [
  title: <>FAQ</>,
  description: (
  <>
- <a href="/docs/faq">Frequently asked questions</a>
+ <a href="/docs/faq/what">Frequently asked questions</a>
  </>
  ),
  },