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

Cleanup MQTT legacy notify instruction using mqtt publish #34260

Merged
merged 1 commit into from
Aug 12, 2024

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Aug 12, 2024

Proposed change

Cleanup MQTT legacy notify instruction using mqtt publish

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

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

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.

Summary by CodeRabbit

  • Documentation
    • Removed the section detailing "MQTT Notifications" from the MQTT integration documentation, streamlining content and potentially indicating a change in functionality.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Aug 12, 2024
Copy link
Contributor

coderabbitai bot commented Aug 12, 2024

Walkthrough

Walkthrough

The documentation for the MQTT integration has undergone significant changes, specifically the removal of the "MQTT Notifications" section. This section previously outlined the differences in notification support for MQTT, provided instructions for sending messages, and included visual aids. Its removal suggests a simplification or a change in functionality related to MQTT notifications.

Changes

Files Change Summary
source/_integrations/mqtt.markdown Removed the "MQTT Notifications" section, which detailed notification differences, action instructions, and visual aids.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DeveloperTools
    participant MQTTBroker

    User->>DeveloperTools: Select mqtt.publish action
    DeveloperTools->>User: Request JSON input
    User->>DeveloperTools: Provide necessary data
    DeveloperTools->>MQTTBroker: Publish message to topic
    MQTTBroker-->>DeveloperTools: Acknowledge message
    DeveloperTools-->>User: Confirmation of message sent
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Aug 12, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit a95a66a
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66b9f1b6fa67ca000887635d
😎 Deploy Preview https://deploy-preview-34260--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @jbouwh 👍

@c0ffeeca7 c0ffeeca7 merged commit ec46c4c into current Aug 12, 2024
8 checks passed
@c0ffeeca7 c0ffeeca7 deleted the mqtt-cleanup-legacy-notify-example branch August 12, 2024 11:34
YogevBokobza pushed a commit to YogevBokobza/home-assistant.io that referenced this pull request Aug 12, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Aug 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants