Adds FAQ for custom_repositories

Jesus7502 · Jun 10, 2020 · 44f9e5c · 44f9e5c
1 parent a1602be
commit 44f9e5c
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 0 deletions.
diff --git a/documentation/faq/custom_repositories.md b/documentation/faq/custom_repositories.md
@@ -0,0 +1,26 @@
+---
+id: custom_repositories
+title: Custom Repositories
+description: "Custom repositories in HACS"
+---
+
+[HACS allready have a lot of repositories by default](https://hacs.xyz/docs/default_repositories)
+
+But there are a number of different reasons why a developer might not want to publish their repository to HACS, for these situations you can in many cases add it to HACS as a custom repository.
+
+:::warning
+Not all repositories will work in HACS, since HACS still needs the repository to have a known structure.
+:::
+
+If you want to try and add a custom repository to HACS do the following:
+
+![custom_repositories_entry](/img/custom_repositories_entry.png)
+
+1. Go to any of the sections (integrations, frontend, automation).
+1. Click on the 3 dots in the top right corner.
+1. Select "Custom repositories"
+1. Add the URL to the repository.
+1. Select the correct category.
+1. Click the "ADD" button.
+
+![custom_repositories](/img/custom_repositories.png)
diff --git a/sidebars.js b/sidebars.js
@@ -68,6 +68,7 @@ module.exports = {
  "faq/installation",
  "faq/upgrade",
  "faq/status_not_loaded",
+ "faq/custom_repositories",
  "faq/limitations",
  ],
  },

diff --git a/static/img/custom_repositories.png b/static/img/custom_repositories.png
diff --git a/static/img/custom_repositories_entry.png b/static/img/custom_repositories_entry.png