Skip to content

Add documentation for DROP integration #29947

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Dec 22, 2023
Merged

Add documentation for DROP integration #29947

merged 7 commits into from
Dec 22, 2023

Conversation

pfrazer
Copy link
Contributor

@pfrazer pfrazer commented Nov 21, 2023 •
edited
Loading

Proposed change

Add documentation for a new DROP integration. Information about the product line using this new integration is at https://dropconnect.com/ .

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in another repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Nov 21, 2023
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

This was referenced Nov 21, 2023
Merged
Merged
@home-assistant home-assistant bot removed the needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch label Nov 21, 2023
@klaasnicolaas klaasnicolaas added the new-integration This PR adds documentation for a new Home Assistant integration label Nov 29, 2023
jbouwh
jbouwh reviewed Dec 21, 2023
View reviewed changes
@joostlek joostlek added the parent-merged The parent PR has been merged already label Dec 22, 2023
jbouwh
jbouwh approved these changes Dec 22, 2023
View reviewed changes
Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM,
Thnx @pfrazer 👍

@jbouwh jbouwh merged commit bb3447b into home-assistant:next Dec 22, 2023
@home-assistant home-assistant bot removed in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already labels Dec 22, 2023
@pfrazer pfrazer deleted the drop branch December 22, 2023 16:25
@github-actions github-actions bot locked and limited conversation to collaborators Dec 23, 2023
frenck
frenck reviewed Dec 27, 2023
View reviewed changes
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pfrazer Please take a look at these comments and address those in a new PR.

source/_integrations/drop_connect.markdown
Comment on lines +57 to +59
Once the DROP Hub is connected to your MQTT broker, the devices on your DROP system will be discovered by Home
Assistant.
Go to **Settings > Devices & Services** in the Home Assistant UI to add your DROP devices.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't the correct way to guide users to set up an integration. We have templates for that available, which must be used.

@pfrazer Please address this in a new PR.

../Frenck

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in #30527

source/_integrations/drop_connect.markdown
- **RO Filter**: reverse osmosis drinking water filtration.
- **Salt Sensor**: alerts when the salt level in the softener brine tank is low.

### Configuration
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not integration configuration, but device configuration.

This section should be called "Pre-requisites" instead.

Please address this in a new PR

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Address in #30527

source/_integrations/drop_connect.markdown
Comment on lines +38 to +50
recommended
that you create a unique user to connect your DROP Hub to your MQTT broker. If you are
using the Mosquitto add-on, go to **Settings > Add-ons** in the Home Assistant UI and select the Mosquitto broker.
Under **Configuration**, enter a new username and password for your DROP Hub in the **Logins** field:

```yaml
- username: drop
password: your_unique_password
```

If you are using a different MQTT broker, please reference its documentation to learn how to add a new user.

To enable the DROP integration, use the DROP Connect app to connect your DROP Hub to your MQTT broker:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have many users not using add-ons... this is super confusing as this is integration documentation and not device or add-on documentation

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was the one who suggested this, I'll open a followup PR on next.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#30527

@frenck
Copy link
Member

frenck commented Dec 27, 2023

/CC @jbouwh, please mark PRs as these as parent-merged so the docs team can take a look before merging. Thanks 👍

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@frenck frenck frenck left review comments

@jbouwh jbouwh jbouwh approved these changes

Assignees
No one assigned
Labels
has-parent This PR has a parent PR in another repo new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch
Projects
No open projects
Documentation PRs
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@pfrazer @frenck @jbouwh @joostlek @klaasnicolaas