Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Next #465

Draft
wants to merge 121 commits into
base: main
Choose a base branch
from
Draft

Next #465

Changes from 1 commit
Commits
Show all changes
121 commits
Select commit Hold shift + click to select a range
bcbc9e3
Re-init experimental
ludeeus Mar 5, 2023
3126dea
Merge branch 'main' of github.com:hacs/documentation into experimental
ludeeus Mar 5, 2023
8a0452c
Move _redirects file
ludeeus Mar 6, 2023
63f6733
Update Carousel images
ludeeus Mar 7, 2023
bea9463
Add template documentation
ludeeus Apr 6, 2023
fe5c55e
Add missing link to template from start
ludeeus Apr 6, 2023
beeb9f9
Note about not needing homeassistant.reload_custom_templates
ludeeus Apr 8, 2023
bb395fc
Add note
ludeeus Apr 9, 2023
c1182ef
image
ludeeus Apr 9, 2023
9aea648
adjust image
ludeeus Apr 9, 2023
bb4b89b
Use banner
ludeeus Apr 9, 2023
c8cfa21
Fix typo (#370)
timmo001 Apr 9, 2023
1ff8834
Update init config image
ludeeus Sep 24, 2023
fcc1ec2
Bump min version
ludeeus Sep 24, 2023
b21cf4c
Remove sensor
ludeeus Sep 25, 2023
37c4463
Update options.md (#387)
reedy Sep 30, 2023
b2385c4
Merge branch 'main' of github.com:hacs/documentation into experimental
ludeeus Sep 30, 2023
ddbb403
Merge branch 'main' of github.com:hacs/documentation into experimental
ludeeus Oct 1, 2023
59e91f4
Update overview
ludeeus Oct 7, 2023
fcac33c
Remove stores
ludeeus Oct 7, 2023
d402e80
rename overview -> dashboard
ludeeus Oct 8, 2023
25ef803
Simplify indexes
ludeeus Oct 8, 2023
d2f4c36
Update title
ludeeus Oct 8, 2023
7d9c120
Add quick actions
ludeeus Oct 8, 2023
cebf7e5
Add repository dashboard
ludeeus Oct 8, 2023
e604d05
Add menu docs
ludeeus Oct 8, 2023
5263ecf
Merge branch 'main' of github.com:hacs/documentation into experimental
ludeeus Oct 15, 2023
3a7c3f0
adjust index files
ludeeus Oct 15, 2023
3a56f96
Merge branch 'main' of github.com:hacs/documentation into experimental
ludeeus Oct 30, 2023
e9c8680
Add docs for using versions in update service (#402)
ludeeus Jan 21, 2024
a8188a7
Adjust filters to show the dialog (#430)
ludeeus Jan 21, 2024
2d28137
fix links
ludeeus Jan 21, 2024
a2a0834
Merge branch 'main' of github.com:hacs/documentation into experimental
ludeeus May 22, 2024
e849e7b
Merge branch 'main' of github.com:hacs/documentation into experimental
ludeeus May 22, 2024
19a91f1
Fix links
ludeeus May 22, 2024
53287ca
Switch experimental docs to mkdocs (#461)
ludeeus May 27, 2024
4eea847
Use stable env var for site URL
ludeeus May 27, 2024
9f7865a
Update prerequisites.md - removing duplicate entry (#462)
david-w-t May 29, 2024
6d4f147
Replace panel sreenshots
ludeeus Jun 5, 2024
76b7186
Merge branch 'main' of github.com:hacs/documentation into next
ludeeus Jun 5, 2024
c2a786f
typos
ludeeus Jun 5, 2024
72fee68
Remvoe netdaemon
ludeeus Jun 5, 2024
64383eb
Enable blog
ludeeus Jun 5, 2024
5f08a82
Compress images
ludeeus Jun 5, 2024
a14e7a6
No optimize
ludeeus Jun 5, 2024
39ef1ac
more
ludeeus Jun 5, 2024
94947ef
Replace images for custom repository
ludeeus Jun 5, 2024
6857996
Extemd plugin to lazy load images
ludeeus Jun 5, 2024
88cd3b7
Add macro to reuse frontend translation strings
ludeeus Jun 6, 2024
b1893c3
Update frontend dev description
ludeeus Jun 7, 2024
ff290b9
Devcontainers: add links to related external resources (#470)
c0ffeeca7 Jun 17, 2024
5695dd0
Abbreviations: add HACS (#471)
c0ffeeca7 Jun 17, 2024
65ad1a7
Contributing to docs: style tweaks (#472)
c0ffeeca7 Jun 18, 2024
7091801
Documentation: update headers and structure (#473)
c0ffeeca7 Jun 18, 2024
138699f
Enable action
ludeeus Jun 18, 2024
e816510
Documentation: add section about screenshotting (#475)
c0ffeeca7 Jun 18, 2024
a9f66ea
User docs landing page: tiny tweak (#476)
c0ffeeca7 Jun 18, 2024
009878d
Backend: add instructions, target branch, and repo location (#474)
c0ffeeca7 Jun 18, 2024
f8fb74c
Add support for shortcodes and my links
ludeeus Jun 18, 2024
a76d22c
User docs prereqs: add links to related HA docs (#477)
c0ffeeca7 Jun 18, 2024
2fc6671
Download HACS: Update OS steps to include add-on (#478)
c0ffeeca7 Jun 19, 2024
2cdd716
User docs prereqs: rephrase note that there are no add-ons (#480)
c0ffeeca7 Jun 19, 2024
e8da225
Download: fix step on opening my link (#481)
c0ffeeca7 Jun 19, 2024
c9270e1
Add prerequisites admonition
ludeeus Jun 19, 2024
3bdfc7e
change icon
ludeeus Jun 19, 2024
51e45e1
Add step to continue by installing the integration (#483)
c0ffeeca7 Jun 19, 2024
f62366d
Contribute docs: tweaks (#484)
c0ffeeca7 Jun 20, 2024
7452fe9
Diagnostics: rephrase (#485)
c0ffeeca7 Jun 20, 2024
160ca25
Remove experimental
ludeeus Jun 20, 2024
644fdd7
Logs add note (#486)
c0ffeeca7 Jun 20, 2024
b63a46e
Integration installation: rephrase procedure (#482)
c0ffeeca7 Jun 20, 2024
974df96
User doc landing page: add getting started procedure (#487)
c0ffeeca7 Jun 20, 2024
b96b275
Rephrase types landing page title and description (#489)
c0ffeeca7 Jun 20, 2024
073a2e2
Templates: rephrase (#490)
c0ffeeca7 Jun 20, 2024
b492516
Add troubleshooting section (#488)
c0ffeeca7 Jun 20, 2024
68c2dbb
Themes: add links (#491)
c0ffeeca7 Jun 20, 2024
caaaf8f
Add kwargs to shortcodes
ludeeus Jun 21, 2024
12dd5f5
Download location: add link (#492)
c0ffeeca7 Jun 25, 2024
de73390
Set python version to 3.8 (#494)
ludeeus Jun 25, 2024
0b62856
Dashboard: rephrase (#493)
c0ffeeca7 Jun 25, 2024
92bc98e
Help us: tiny rephrase (#495)
c0ffeeca7 Jun 25, 2024
c06eb43
Remove changing config section. (#496)
c0ffeeca7 Jun 25, 2024
1ebfedc
change config options: rephrase procedure (#497)
c0ffeeca7 Jun 25, 2024
d699995
Initial config: add intro, rephrase (#498)
c0ffeeca7 Jun 25, 2024
4e7a9b7
Type dashboard: fix typo, tiny rephrase (#500)
c0ffeeca7 Jun 25, 2024
ef76f7d
Type AppDaemon: rephrase (#499)
c0ffeeca7 Jun 25, 2024
070514a
Type AppDaemon: fix indent (#501)
c0ffeeca7 Jun 25, 2024
db00a1d
minor style update
ludeeus Jul 1, 2024
cb6fd7f
Themes: rephrase, remove info box (#505)
c0ffeeca7 Jul 2, 2024
c13c366
More style fixes
ludeeus Jul 3, 2024
021c313
Use: integration type: rephrase to make more procedural (#503)
c0ffeeca7 Jul 3, 2024
d963b67
Python Script: rephrase (#504)
c0ffeeca7 Jul 3, 2024
66f378e
Troubleshooting: tiny tweak (#506)
c0ffeeca7 Jul 3, 2024
bcdfbad
Abrreviation: remove italics, they are not displayed in pop-up (#507)
c0ffeeca7 Jul 3, 2024
f8297da
Revamp landing page (#510)
ludeeus Jul 3, 2024
c5286f8
Download HACS: add intro para (#509)
c0ffeeca7 Jul 3, 2024
e24014f
lightmode fixes
ludeeus Jul 3, 2024
6d4755f
HACS main dashboard: rephrase title and intro to be more procedural (…
c0ffeeca7 Jul 3, 2024
9a7a44e
Fix
ludeeus Jul 3, 2024
be6a5b2
More light mode fixes
ludeeus Jul 3, 2024
298aec0
Removing HACS: rephrase (#511)
c0ffeeca7 Jul 3, 2024
d84179f
Configuration: change title to align with other titles (#512)
c0ffeeca7 Jul 3, 2024
c3525e7
Repo types: rename title (#513)
c0ffeeca7 Jul 3, 2024
ce7df47
Category -> Type rename
ludeeus Jul 3, 2024
1c6e510
add margin
ludeeus Jul 3, 2024
9a21889
Fix github docs links
ludeeus Jul 3, 2024
eb65dff
FAQ GitHub account: rephrase (#514)
c0ffeeca7 Jul 3, 2024
65d120d
Intro sections: rephrase (#515)
c0ffeeca7 Jul 3, 2024
95adda3
Nav structure: move 'Removing HACS' out of 'Download' section (#516)
c0ffeeca7 Jul 3, 2024
a277217
Replace the footer (#517)
ludeeus Jul 3, 2024
1a756fe
Remove docs/use/updates.md
ludeeus Jul 3, 2024
b74ef1b
More style changes
ludeeus Jul 3, 2024
f7f06d5
FAQ Cleanup
ludeeus Jul 4, 2024
ae5076e
bump mkdocs-material to 9.5.28
ludeeus Jul 4, 2024
32c26da
reduce weight
ludeeus Jul 4, 2024
0086522
Downloading a repo: rephrase (#518)
c0ffeeca7 Jul 4, 2024
96c3b47
Data: add links to docs on creating and restoring from backups (#519)
c0ffeeca7 Jul 4, 2024
ace64f7
My link: rephrase (#520)
c0ffeeca7 Jul 4, 2024
2fb4ace
Diagnostics: fix step number and other tweaks (#521)
c0ffeeca7 Jul 4, 2024
56b416d
Use keyboard key refrence
ludeeus Jul 9, 2024
525993a
Remove number of releases to show
ludeeus Jul 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Initial config: add intro, rephrase (#498)
* Initial config: add intro, rephrase

* fix typo

* Fix indent

* remove unnecessary technical jargon
  • Loading branch information
c0ffeeca7 committed Jun 25, 2024
commit d6999959fdd6324f432c1c24779d765641461ac5
12 changes: 8 additions & 4 deletions source/docs/use/configuration/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@ title: Initial configuration
description: 'Setting up and authenticating the HACS integration'
---

## Prerequisites
## Setting up the HACS integration

Follow these steps to set up the HACS integration and authenticate it with GitHub.

### Prerequisites

This page assumes that you have completed the following steps:

This guide assumes that you have completed the following steps:

- [Downloaded HACS](/docs/use/download/prerequisites.md)
- Restarted Home Assistant

## Setting up the HACS integration
### To setting up the HACS integration

1. In Home Assistant, go to <!-- hacs:my integrations title="**{{coreui('panel.config')}}** > **{{coreui('ui.panel.config.dashboard.devices.main')}}**" -->.
2. Clear your browser cache.
Expand All @@ -23,7 +27,7 @@ This page assumes that you have completed the following steps:
4. Search for **HACS** and select it.
5. Acknowledge the statements and select **Submit**.
6. Authenticate the integration:
- HACS uses a device OAuth flow for authentication against the GitHub API.
- HACS uses a device OAuth flow for authentication with GitHub.
- Copy the device code and select the link [https://github.com/login/device](https://github.com/login/device).

![image](/assets/images/config_flow/part2.png)
Expand Down