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

Document use of Persistent Notification as a notifier #23336

Merged
merged 3 commits into from
Jun 27, 2023

Conversation

KevinCathcart
Copy link
Contributor

Proposed change

Adds documentation for using the Persistent Notification integration as a notifier. This was never actually documented back when the feature was added (my fault), and the linked PR is updating it to support notification_id in the data section which needs to be documented, which means i need to fix the previous omission, and document the new parameter.

While the code actually lives in the notify integration, it is documented with the persistent_notification integration to better match how all other notifies are documented, and because the implementation location is is not supposed to be a user visible detail.

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.

@KevinCathcart KevinCathcart requested a review from a team as a code owner July 9, 2022 17:43
@probot-home-assistant probot-home-assistant bot added the has-parent This PR has a parent PR in a other repo label Jul 9, 2022
@probot-home-assistant probot-home-assistant bot added the next This PR goes into the next branch label Jul 9, 2022
Copy link
Contributor

@deviantintegral deviantintegral left a comment

Choose a reason for hiding this comment

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

Some comments, but honestly neither seems like a required change. Everything looks good to me at https://deploy-preview-23336--home-assistant-docs.netlify.app/integrations/persistent_notification/#use-as-a-notifier

Comment on lines 16 to 17
If you want to send notifications to the Home Assistant web interface, you may use the [Persistent Notification integration](/integrations/persistent_notification/). The Persistent Notification integration is also available as a automatically configured notifier. See its documentation for more details.

Copy link
Contributor

Choose a reason for hiding this comment

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

How about linking See its documentation to the Use as a notifier heading?

source/_integrations/persistent_notification.markdown Outdated Show resolved Hide resolved
@frenck frenck added the parent-merged The parent PR has been merged already label Jun 26, 2023
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.

Thanks, @KevinCathcart 👍

../Frenck

@frenck frenck merged commit 432b5bd into home-assistant:next Jun 27, 2023
7 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Jun 27, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Jun 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

4 participants