Small tweaks to installation procedure (#283)

frenck · Aug 10, 2023 · 811141e · 811141e
1 parent ac79e5c
commit 811141e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 44 deletions.
diff --git a/documentation/installation.md b/documentation/installation.md
@@ -46,11 +46,6 @@ If you have met these requirements, you are ready to install Spook. 🎉
 
 Time to download and install Spook 👻 onto your Home Assistant instance.
 
-:::{note}
-HACS can be configured to run in two different modes: **standard** and **experimental**. Spook is available in both modes, but the installation process is differs slightly.
-If you are using the **experimental** mode, be sure to select the **HACS with experimental mode enabled** tab below.
-:::
-
 :::{tip}
 You can use select the {term}`My Home Assistant` button below, which will navigate you to Spook in HACS directly on your Home Assistant instance.
 
@@ -59,6 +54,9 @@ You can use select the {term}`My Home Assistant` button below, which will naviga
 You can directly go to step 6 if you use the button above (step 4 in case of using HACS experimental mode).
 :::
 
+HACS can be configured to run in two different modes: **standard** and **experimental**. Spook is available in both modes, but the installation process is differs slightly.
+If you are using the experimental mode, be sure to select the **HACS with experimental mode enabled** tab below.
+
 ::::{tab-set}
 
 :::{tab-item} Standard HACS
@@ -68,57 +66,42 @@ You can directly go to step 6 if you use the button above (step 4 in case of usi
 2. Select **Integrations**.
 
    ```{figure} images/installation/hacs_integrations.png
-   :name: Open HACS and go to integrations
    :alt: Screenshot showing the HACS dashboard.
    :align: center
-
-   Spook is an integration, so we need to go to the integrations page in HACS.
    ```
 
 3. Select the **Explore & download repositories** button in the bottom right corner.
 4. Select the search bar in the dialog shown and search for `Spook`.
 5. Spook should now appear in the search results. Select it.
 
    ```{figure} images/installation/hacs_find_spook.png
-   :name: Find and install Spook in HACS
    :alt: Screenshot showing the HACS dashboard searching for Spook.
    :align: center
-
-   Finding Spook in the Home Assistant Community Store.
    ```
 
 6. On the Spook page in HACS, select the **Download** button in the bottom right corner.
 
    ```{figure} images/installation/hacs_download_fab.png
-   :name: Select the Download button on the Spook page in HACS
    :alt: Screenshot showing the Spook page in the HACS store.
    :align: center
-
-   Select the big download button in the bottom right.
    ```
 
 7. In the download dialog shown, select **Download** to download the Spook integration to your Home Assistant instance.
 
    ```{figure} images/installation/hacs_download.png
-   :name: Download Spook in HACS
    :alt: Screenshot showing the download dialog in HACS.
    :align: center
-
-   Download Spook in HACS.
    ```
 
 8. After the download process has been completed, you need to restart Home Assistant in order for Home Assistant to see the new Spook integration.
 
    1. Select **Settings** from the sidebar, and then select **System**.
-   2. Select the power button in the top right corner.
+   2. In the top right corner select the power button.
    3. Select **Restart Home Assistant** in the dialog that appears.
 
    ```{figure} images/installation/restart_home_assistant.png
-   :name: Restart Home Assistant
    :alt: Screenshot showing the Home Assistant restart dialog.
    :align: center
-
-   Restart Home Assistant.
    ```
 
 :::
@@ -131,45 +114,33 @@ You can directly go to step 6 if you use the button above (step 4 in case of usi
 3. Spook should now appear in the search results. Select it.
 
    ```{figure} images/installation/hacs_experimental_find_spook.png
-   :name: Find and install Spook in HACS
    :alt: Screenshot showing the HACS dashboard searching for Spook.
    :align: center
-
-   Finding Spook in the Home Assistant Community Store.
    ```
 
 4. On the Spook page in HACS, select the **Download** button in the bottom right corner.
 
    ```{figure} images/installation/hacs_experimental_download_fab.png
-   :name: Select the Download button on the Spook page in HACS
    :alt: Screenshot showing the Spook page in the HACS store.
    :align: center
-
-   Select the big download button in the bottom right.
    ```
 
 5. In the download dialog shown, select **Download** to download the Spook integration to your Home Assistant instance.
 
    ```{figure} images/installation/hacs_experimental_download.png
-   :name: Download Spook in HACS
    :alt: Screenshot showing the download dialog in HACS.
    :align: center
-
-   Download Spook in HACS.
    ```
 
 6. After the download process has been completed, you need to restart Home Assistant in order for Home Assistant to see the new Spook integration.
 
    1. Select **Settings** from the sidebar, and then select **System**.
-   2. Select the power button in the top right corner.
+   2. In the top right corner select the power button
    3. Select **Restart Home Assistant** in the dialog that appears.
 
    ```{figure} images/installation/experimental_restart_home_assistant.png
-   :name: Restart Home Assistant
    :alt: Screenshot showing the Home Assistant restart dialog.
    :align: center
-
-   Restart Home Assistant.
    ```
 
 :::
@@ -191,35 +162,26 @@ You can skip steps 1, 2, 3, and 4 if you use the button above.
 :::
 
 1. From the Home Assistant sidebar, select **Settings** and next select **Devices & Services**.
-2. On the Devices & Services page, select the **+ Add integration** button in the bottom right corner.
+2. On the Devices & Services page, in the bottom right corner, select the **+ Add integration** button.
 
    ```{figure} images/installation/add_integration.png
-   :name: Add an integration to Home Assistant
    :alt: Screenshot showing the device & services page in Home Assistant.
    :align: center
-
-   We are going to add a new integration to Home Assistant.
    ```
 
 3. Select the search bar at the top of the dialog shown and search for `Spook`.
 4. Spook should now appear in the search results. Select it.
 
    ```{figure} images/installation/find_spook.png
-   :name: Find Spook in the integration search
    :alt: Screenshot showing showing the integration search dialog in Home Assistant.
    :align: center
-
-   Finding the Spook integration to add to Home Assistant.
    ```
 
 5. Confirm you have read, understood, and accepted [the license](license). Then select **Submit**.
 
    ```{figure} images/installation/accept_license.png
-   :name: Accept the license
    :alt: Screenshot showing the Spook add integration dialog in Home Assistant.
    :align: center
-
-   Only click submit if you have read, understood, and accepted the license of Spook.
    ```
 
 6. It now takes a few seconds for the Spook integration to be set up, after which a success dialog will appear. Select **Finish** to close the dialog.

diff --git a/documentation/myst.yml b/documentation/myst.yml
@@ -16,6 +16,9 @@ site:
 
 project:
   title: Spook 👻 Not your homie.
+  short_title: Spook 👻
+  name: Spook 👻
+  subject: Spook 👻
   description: "👻 Spook is a scary powerful toolbox for Home Assistant."
   keywords:
     - spook