Skip to content

Commit

Permalink
Minor doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
ludeeus committed Feb 10, 2022
1 parent 6697820 commit 40233aa
Show file tree
Hide file tree
Showing 8 changed files with 39 additions and 45 deletions.
2 changes: 0 additions & 2 deletions documentation/basic/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ To enable `debug` logging, add this to your `configuration.yaml`:
logger:
default: info
logs:
hacs: debug
custom_components.hacs: debug
queueman: debug
aiogithubapi: debug
```
4 changes: 3 additions & 1 deletion documentation/configuration/legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ description: "Configure HACS with YAML (legacy)"
---

:::info
_This page assume that you have already finished the [download](/docs/setup/prerequisites)_
_This page assume that you have already finished the [download](/docs/setup/prerequisites)_.
New installations should not use this.
Use [this](/docs/configuration/basic) instead
:::

## Example configuration
Expand Down
10 changes: 0 additions & 10 deletions documentation/configuration/start.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: download
title: Download
description: "HACS download steps"
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

You use the [HACS download script](https://github.com/hacs/get) to setup HACS.

Expand All @@ -13,9 +15,10 @@ If you are not sure what type of Home Assistant you are using, then you should p

:::

## Home Assistant OS
<Tabs label="test">
<TabItem value="os" label="OS/Supervised" default>

1. Go to the Supervisor panel
1. Go to the [Add-on store](https://my.home-assistant.io/redirect/supervisor_store/)
1. Install one of the SSH add-ons (you need to enable advanced mode in your user profile to see them)
1. Configure the SSH add-on you chose by following the documentation for it
1. Start the SSH add-on
Expand All @@ -26,11 +29,14 @@ If you are not sure what type of Home Assistant you are using, then you should p
wget -O - https://get.hacs.xyz | bash -
```

## Home Assistant Container
</TabItem>
<TabItem value="container" label="Container">

For Home Assistant Container you have 2 options.

### Option 1: Run the downloader on the host OS
<Tabs>
<TabItem value="host" label="Host" default>


1. Open a terminal
1. Change directory to your Home Assistant configuration directory
Expand All @@ -40,7 +46,8 @@ For Home Assistant Container you have 2 options.
wget -O - https://get.hacs.xyz | bash -
```

### Option 2: Run the downloader inside the container
</TabItem>
<TabItem value="container" label="Container">

1. Open a terminal
1. Go inside the container with `docker exec -it homeassistant bash`
Expand All @@ -50,10 +57,13 @@ wget -O - https://get.hacs.xyz | bash -
wget -O - https://get.hacs.xyz | bash -
```

4. Exit the container with `exit`

</TabItem>
</Tabs>


## Home Assistant Core
</TabItem>
<TabItem value="core" label="Core">

1. Open a terminal
1. Change to the user that is running Home Assistant
Expand All @@ -63,23 +73,17 @@ wget -O - https://get.hacs.xyz | bash -
wget -O - https://get.hacs.xyz | bash -
```

## Home Assistant Supervised
</TabItem>

The same as [Home Assistant OS](#home-assistant-os), but you can also run the script directly on the host OS.
</Tabs>

1. Open a terminal
1. Run the HACS download script

```bash
wget -O - https://get.hacs.xyz | bash -
```

:::tip
## Troubleshooting

Having issues accessing `https://get.hacs.xyz`? try this instead:

```
wget -O - https://raw.githubusercontent.com/hacs/get/main/get | bash -
```
- CTRL+V not working for you?
- Try CTRL+SHIFT+V instead

:::
- Having issues accessing `https://get.hacs.xyz` in the terminal?
- Try it with `https://raw.githubusercontent.com/hacs/get/main/get` instead
16 changes: 8 additions & 8 deletions documentation/setup/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: "Prerequisites"

## Requirements

:::warning
If you do not have or know **_all_** of the following, **do not** try to setup/use HACS.
:::caution
If **all** of the points in the list below does not match you, **do not** try to setup/use HACS.
:::

- Home Assistant version `2021.9.0` or newer
- A GitHub account
- A [supported](https://github.com/home-assistant/architecture/blob/master/adr/0012-define-supported-installation-method.md) Home Assistant installation
- Access to the filesystem where Home Assistant is located
- **You know how to access the Home Assistant log file**
- **A stable internet connection with sufficient available data or no data caps**
- You are running [Home Assistant](https://www.home-assistant.io/) version [`2021.9.0`](https://my.home-assistant.io/redirect/info) or newer.
- You are running a [supported](https://github.com/home-assistant/architecture/blob/master/adr/0012-define-supported-installation-method.md) Home Assistant installation.
- You have Access to the filesystem where the Home Assistant configuratioin files is located.
- You know how to access the Home Assistant log file.
- You are aware that there are **no** [add-ons](https://www.home-assistant.io/docs/glossary/#add-on) in HACS.
- You have a stable internet connection with sufficient available data or no data caps
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module.exports = {
title: 'HACS',
items: [
{ to: 'docs/setup/prerequisites', label: 'Download', position: 'left' },
{ to: 'docs/configuration/start', label: 'Configuration', position: 'left' },
{ to: 'docs/configuration/basic', label: 'Configuration', position: 'left' },
{ to: 'docs/basic/getting_started', label: 'Usage', position: 'left' },
{ to: 'docs/community_guides', label: 'Guides', position: 'left' },
{ to: 'default_repositories', label: 'Repositories', position: 'left' },
Expand Down
4 changes: 2 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ module.exports = {
},
setup: {
Setup: ['setup/prerequisites', 'setup/download'],
Configuration: ['configuration/start', 'configuration/basic', 'configuration/options'],
'Legacy Configuration (YAML)': ['configuration/legacy'],
Configuration: ['configuration/basic', 'configuration/options'],
'Legacy Configuration': ['configuration/legacy'],
Remove: ['setup/remove'],
},
'developer documentation': {
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ function Home() {
'button button--outline button--secondary button--lg btt',
styles.indexButton,
)}
to={useBaseUrl('docs/configuration/start')}
to={useBaseUrl('docs/configuration/basic')}
>
CONFIGURE
</Link>
Expand Down

0 comments on commit 40233aa

Please sign in to comment.