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

Remove RTSPtoWebRTC #35955

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Remove RTSPtoWebRTC #35955

merged 1 commit into from
Nov 25, 2024

Conversation

edenhaus
Copy link
Contributor

@edenhaus edenhaus commented Nov 24, 2024

Proposed change

Remove docs as integration is deprecated

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: Deprecate RTSPtoWebRTC core#131467
  • 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

  • Chores
    • Removed outdated documentation for the RTSPtoWebRTC integration.
    • Updated and added numerous URL redirects for improved navigation and resource accessibility.
    • Redirects now point to new integration paths and community resources, enhancing user experience.
    • Introduced redirects for removed integrations, guiding users to relevant information.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Nov 24, 2024
Copy link

netlify bot commented Nov 24, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 6649854
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67434c6a34131600081e432f
😎 Deploy Preview https://deploy-preview-35955--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

coderabbitai bot commented Nov 24, 2024

📝 Walkthrough

Walkthrough

The changes include the deletion of the documentation file for the RTSPtoWebRTC integration and extensive updates to the _redirects file. The RTSPtoWebRTC integration documentation outlined the configuration and functionality for streaming RTSP cameras via WebRTC in Home Assistant. The _redirects file modifications involve adding new redirects for community resources and integration pages, updating existing redirects to reflect new structures, and removing outdated integrations. This restructuring aims to enhance navigation and resource accessibility.

Changes

File Path Change Summary
source/_integrations/rtsp_to_webrtc.markdown Deleted documentation for the RTSPtoWebRTC integration, including configuration and troubleshooting details.
source/_redirects Extensive updates including:
- Added new redirects for community resources and integrations.
- Updated existing redirects to new paths.
- Removed redirects for deprecated integrations.
- Introduced handling for specific paths with status codes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant RTSPtoWebRTCServer
    participant WebRTCClient

    User->>HomeAssistant: Request to stream RTSP camera
    HomeAssistant->>RTSPtoWebRTCServer: Connect to RTSP camera
    RTSPtoWebRTCServer-->>HomeAssistant: Stream URL
    HomeAssistant->>WebRTCClient: Provide stream URL
    WebRTCClient->>RTSPtoWebRTCServer: Establish peer connection
    RTSPtoWebRTCServer-->>WebRTCClient: Stream video
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5a56744 and 6649854.

📒 Files selected for processing (2)
  • source/_integrations/rtsp_to_webrtc.markdown (0 hunks)
  • source/_redirects (1 hunks)
💤 Files with no reviewable changes (1)
  • source/_integrations/rtsp_to_webrtc.markdown
🧰 Additional context used
📓 Path-based instructions (1)
source/_redirects (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

🔇 Additional comments (1)
source/_redirects (1)

608-608: Approve the redirect for the removed RTSPtoWebRTC integration

The redirect correctly points to the removed integration page with a 301 status code.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

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.

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Nov 25, 2024
@frenck frenck merged commit 4ff992a into next Nov 25, 2024
9 checks passed
@frenck frenck deleted the edenhaus-rtsp-to-webrtc branch November 25, 2024 23:47
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Nov 25, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Nov 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants