hacs / documentation Goto Github PK
View Code? Open in Web Editor NEWDocumentation for HACS
Home Page: https://hacs.xyz/
License: MIT License
Documentation for HACS
Home Page: https://hacs.xyz/
License: MIT License
BWALARM is not updating correctly
Hi there,
this is my video guide/tutorial - https://youtu.be/4cOdgW23KCA
If you think that the video is helpful you can put it somewhere in the README.md
Or I if it's easier for you I can do that and create a Pull request
Either way keep up the good work.
Cheers,
Kiril
Hobbyist here, just installed HACS in Home Assistant running in a venv on a Pi 4. Working great so far, thanks for putting it together! That said, I wanted to make some suggestions on the installation instructions.
Suggestion 1:
Step 4 of the installation ("Create custom_components folder") should really go before Step 3, because you can't do Step 3 until you do Step 4. If you CAN do Step 3, that means you don't have to do Step 4. Better yet, just consolidate the two steps into one:
Step 3 - Move along the hacs folder to HA
Check to see if there is a "custom_component" directory in your Home Assistant installation. If not, create one, where <config_dir> is the directory that contains "configuration.yaml":
<config_dir>/custom_components/Copy the folder named "hacs" to your Home Assistant installation in the folder:
<config_dir>/custom_components/On Hassio/Docker the final location will be:
/config/custom_components/hacsOn Hassbian(venv) the final location will be:
/home/homeassistant/.homeassistant/custom_components/hacs
Suggestion 2:
The installation could be greatly simplified by just providing command-line instructions. For instance, here's what I did:
cd /<config_dir>
(where <config_dir>
is the location of 'configuration.yaml')
mkdir custom_components
mkdir hacs
cd custom_components/hacs
wget https://github.com/hacs/integration/releases/latest/download/hacs.zip
unzip hacs.zip
/local
or the /community
path?fsck
it on another box, even though, for new users the ambigous installation documentation should be alleviated somehow (imho).Is your feature request related to a problem? Please describe.
When migrating to a new system, a VM, I had to re-install HACS, and I was left extremely confused by the new method of enabling themes. The current method of just showing it based on if Home Assistant is configured to be able to see the themes isn't very intuitive for new users.
Describe the solution you'd like
Put tab visibility in the settings of HACS, allow enabling and disabling of the Themes/Python Scripts/etc tabs be just a setting that you can flip on and off. Maybe make the default settings of the visibility based on the current system, and if the user enables anything they don't have properly configured like enabling the themes tab without adding "!include_dir_merge_named theme" to your configuration.yaml it has a giant red card at the top of the themes tab telling the user that it's not properly configured, and prompting the user to visit the proper page in the documentation to configure it properly.
Describe alternatives you've considered
Maybe instead, or really in addition to, just rework the documentation flow to be more of a step by step format? Following the hacs.xyz page isn't super easy to follow. Starting at installation and clicking "next" like what is intuitive doesn't take you to the next step most of the time. The page structure goes directly from installing to removing when following the "next" button like one would expect to do, and if you don't know what links to click through, you won't ever see the /themes page where it tells the user how to enable the themes tabs. When following instructions, and it's not super clear to a new user the actual process to follow.
Additional context
I would be willing to help work on the documentation front, and plan on making some PRs next time I have some free time, probably in late February early march.
These parts are missing from the documentation:
I've search and found that fix #2464 solves the issue but a manual upgrade is required. Can someone tell me how should I update HACS manually without breaking existing intergations?
I'm not sure, but I believe this issue was solved in version 1.20.0 (#2464)
Unfortunately because of issue #2556 you can not update past 1.19.3 using the normal update method at the moment.
Originally posted by @ManCaveMedia in hacs/integration#2563 (comment)
Extremely nit-picky, but, Version 0.19.0 hacs.zip does not unzip to a hacs folder per the doc:
https://hacs.xyz/docs/installation/manual
To reproduce my steps:
I visited:
https://github.com/custom-components/hacs/releases/latest
which redirected to:
https://github.com/hacs/integration/releases/tag/0.19.0
Using GNU Wget 1.19.4 on Ubuntu 18.04.3, I downloaded hacs.zip:
wget https://github.com/hacs/integration/releases/download/0.19.0/hacs.zip
Then I unzipped it using UnZip 6.00
It didn't produce a folder named hacs, but instead it produced the contents of the folder which is probably supposed to be named hacs.
I know how to work around this, but I thought I'd report this discrepancy from the doc.
Hi,
On https://hacs.xyz/docs/publish/integration#github-releases-optional it says that the minimum homeassistant release can be specified but hassfest doesn't allow that.
- [MANIFEST] Invalid manifest: extra keys not allowed @ data['homeassistant']. Got '0.94.0'
Error:
Hi, i've hassio on latest build but when try to install components i've this error:
ERROR (MainThread) [hacs.repository.plugin.thomasloven.lovelace-card-tools] Download was not complete [No content to download]
If i try to upgrade a plugin or install a new one i get errors similar to:
2020-02-29 12:18:58 ERROR (MainThread) [hacs.repository.plugin.ofekashery.vertical-stack-in-card] Download was not complete [Cannot connect to host raw.githubusercontent.com:443 ssl:None [Connect call failed ('::', 443, 0, 0)]]
I have just tried to integrate HACS 0.20.4 and I have unfortunately not succeeded. I followed your instructions exactly, but to no avail. The problem was that the file "custum_updater.py" was in my "custom_components" folder. I deleted the file and everything worked without problems. Can you please insert in your really good description that the "custom_updater.py" file is not available. Thanks again for your effort and great work !!!
I personally judge anything below 50mbit down / 10mbits up connection a bad connection, but due to the current pandemic I'm stuck on a ~12mbit down / it's_not_even_1_mbit up.
How much data (the order of magnitude at least) do you think it will be downloaded during setup and, and what is the timeout?
I guess those would be the 2 factors creating a problem to the installation on a bad connection?
I'm holding off in trying hacs
right now because I don't think this is a good connection, and because of that line, but without data it's hard to judge.
Thanks
0.20.4
The instructions here suggest downloading the release zip file and unzipping it to create a hacs/
folder.
The zip file does not have the files in a folder, so unzipping it just scatters the distribution files in the current directory. Of course it is easy enough to create your own hacs/
folder and unzip in there, but not doing this makes a bit of a mess and is likely to confuse new users.
N/A
I have fully kiosk installed on Amazon Fire 7 tablet. About half the time when it dismisses the screen saver to show my HA dashboard I instead get a large HACS black and white logo instead. I have to then bypass the liosk mode and reload the page to get the dashboard to install. Any idea why this would be happening. I haven't done anything wonky. Just installed it and a couple of custom theme.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.