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 asterisk mailbox docs #34131

Merged
merged 2 commits into from
Aug 12, 2024
Merged

Remove asterisk mailbox docs #34131

merged 2 commits into from
Aug 12, 2024

Conversation

joostlek
Copy link
Member

@joostlek joostlek commented Aug 5, 2024

Proposed change

Remove asterisk mailbox docs

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.

Summary by CodeRabbit

  • New Features

    • Implemented a permanent redirect for the documentation page to ensure users are directed to the updated information.
  • Bug Fixes

    • Resolved potential dead links by redirecting users to relevant content after the removal of certain documentation.

@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 Aug 5, 2024
Copy link
Contributor

coderabbitai bot commented Aug 5, 2024

Walkthrough

Walkthrough

This change introduces a new URL redirect within the application, specifically directing requests from the documentation page /_docs/asterisk_mbox.markdown to /more-info/removed-integration with a 301 status code. This update ensures that users seeking information on the removed integration are automatically guided to relevant resources, improving navigation and user experience by preventing dead links.

Changes

File Change Summary
source/_redirects Added redirect from /_docs/asterisk_mbox.markdown to /more-info/removed-integration with status 301.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between df5c074 and 27de393.

Files selected for processing (1)
  • source/_redirects (1 hunks)
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 not posted (1)
source/_redirects (1)

501-501: LGTM! Redirect addition is correct.

The new redirect entry for /_docs/asterisk_mbox.markdown to /more-info/removed-integration with a 301 status code is consistent with the existing entries for removed integrations. This change ensures users are directed to relevant information.


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 5, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 27de393
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66b78a1e4c578300080b2a82
😎 Deploy Preview https://deploy-preview-34131--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.

frenck
frenck previously requested changes Aug 5, 2024
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.

Please add a redirect for removed integrations in the _redirects file.

@home-assistant home-assistant bot marked this pull request as draft August 5, 2024 13:29
@home-assistant
Copy link

home-assistant bot commented Aug 5, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@frenck frenck added the parent-merged The parent PR has been merged already label Aug 5, 2024
@joostlek
Copy link
Member Author

joostlek commented Aug 5, 2024

Oh right, I forgot to put the question here, as this doesn't seem like a normal integration page, rather a tutorial thingy

@joostlek joostlek marked this pull request as ready for review August 10, 2024 15:41
@home-assistant home-assistant bot requested a review from frenck August 10, 2024 15:41
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, @joostlek 👍

@c0ffeeca7 c0ffeeca7 dismissed frenck’s stale review August 12, 2024 05:36

Requested change has been implemented

@c0ffeeca7 c0ffeeca7 merged commit d91359e into home-assistant:next Aug 12, 2024
6 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Aug 12, 2024
@joostlek joostlek deleted the asterisk branch August 12, 2024 05:37
miaucl pushed a commit to miaucl/home-assistant.io that referenced this pull request Aug 12, 2024
* Remove asterisk mailbox docs

* Fix redirect
@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
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