Skip to content

Add Bluesky links, and add redirects for Bluesky and Mastodon #37329

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

Merged
merged 1 commit into from
Feb 6, 2025

Conversation

ZephireNZ
Copy link
Contributor

@ZephireNZ ZephireNZ commented Feb 6, 2025

Proposed change

Adds an extra link for Bluesky social account, and adds redirects for Bluesky and Mastodon.

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
    • Enhanced the social media footer with a revamped layout that now includes a new Bluesky link and improved presentation for the Mastodon link.
    • Introduced new redirection routes that offer direct access to Mastodon and Bluesky social profiles, ensuring smoother navigation for users.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Feb 6, 2025
Copy link

netlify bot commented Feb 6, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 45adfde
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67a485c347476f00081c9416
😎 Deploy Preview https://deploy-preview-37329--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.

@home-assistant home-assistant bot added the has-parent This PR has a parent PR in a other repo label Feb 6, 2025
@home-assistant
Copy link

home-assistant bot commented Feb 6, 2025

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

@home-assistant home-assistant bot added 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 labels Feb 6, 2025
Copy link
Contributor

coderabbitai bot commented Feb 6, 2025

📝 Walkthrough

Walkthrough

This pull request updates the social media section of the site. In the footer HTML, the formatting of the Mastodon link is adjusted by modifying line breaks, and a new Bluesky link—with its corresponding icon and URL—is added. Additionally, two new redirect entries are incorporated into the redirects configuration file so that requests to the /mastodon and /bluesky paths are forwarded to their respective external URLs.

Changes

File Change Summary
source/_includes/site/footer.html Adjusted line breaks for the Mastodon link and added a new Bluesky link with its icon and URL.
source/_redirects Added two new redirect entries: /mastodon redirects to https://fosstodon.org/@homeassistant and /bluesky redirects to https://bsky.app/profile/home-assistant.io.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant B as Browser
    participant S as Server

    U->>B: Click social media icon in footer
    alt Direct External Link (Bluesky)
      B->>External: Navigate to "https://bsky.app/profile/home-assistant.io"
    else Local Redirect (Mastodon)
      B->>S: Request "/mastodon"
      S-->>B: 301 Redirect to "https://fosstodon.org/@homeassistant"
      B->>External: Navigate to external Mastodon page
    end
Loading

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0781bf2 and 45adfde.

📒 Files selected for processing (2)
  • source/_includes/site/footer.html (1 hunks)
  • source/_redirects (1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in doc...

*/**(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'
  • source/_redirects
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - I...

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

  • If "" are used to mark UI strings, replace them by bold.
  • source/_redirects
`*/**(html|markdown|md)`: - Be brief in your replies and don...

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

  • source/_redirects
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...

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

  • source/_redirects
`*/**(html|markdown|md)`: do not comment on HTML used for ic...

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

  • source/_redirects
`*/**(html|markdown|md)`: Avoid flagging inline HTML for emb...

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

  • source/_redirects
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_redirects (1)

12-13: LGTM!

The new redirects for Mastodon and Bluesky are correctly placed in the "General use redirects" section and follow the same format as other social media redirects.

source/_includes/site/footer.html (1)

88-88: LGTM!

The changes maintain consistency with the existing social media links:

  • Line breaks organize the icons into rows
  • The Bluesky link follows the same format and uses the same icon library
  • The rel="me" attribute is correctly used

Also applies to: 95-100, 107-107


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@ZephireNZ
Copy link
Contributor Author

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases.

This does not depend on changes in frontend (and in fact, should be merged before the other one is due to the redirection links)

@silamon silamon merged commit 66f1215 into home-assistant:current Feb 6, 2025
7 checks passed
@home-assistant home-assistant bot added parent-merged The parent PR has been merged already and removed 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 labels Feb 6, 2025
@ZephireNZ ZephireNZ deleted the feature/update-socials branch February 6, 2025 10:00
@github-actions github-actions bot locked and limited conversation to collaborators Feb 7, 2025
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 has-parent This PR has a parent PR in a other repo parent-merged The parent PR has been merged already
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants