Skip to content

Month of "What the heck?!" 2024 #36074

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 6 commits into from
Nov 30, 2024
Merged

Month of "What the heck?!" 2024 #36074

merged 6 commits into from
Nov 30, 2024

Conversation

frenck
Copy link
Member

@frenck frenck commented Nov 30, 2024

Proposed change

Blog post announcing the Month of "What the heck?!", December 2024.

Summary by CodeRabbit

  • New Features

    • Introduced a new blog post titled "The month of 'What the Heck?!' 2024," encouraging community feedback and discussions.
    • Added a call to action for users to share their experiences on a dedicated community forum.
    • Highlighted improvements made to Home Assistant since the last initiative.
  • Documentation

    • Provided guidance on how users can engage and what types of feedback are sought.

@frenck frenck added the blog This PR adds a blog article to the Home Assistant website label Nov 30, 2024
@home-assistant home-assistant bot added the current This PR goes into the current branch label Nov 30, 2024
Copy link

netlify bot commented Nov 30, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 1445ea1
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/674b6b0ca54a3f000806ac7d
😎 Deploy Preview https://deploy-preview-36074--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 marked this pull request as ready for review November 30, 2024 19:55
Copy link
Contributor

coderabbitai bot commented Nov 30, 2024

📝 Walkthrough

Walkthrough

A new blog post titled "The month of 'What the Heck?!' 2024" has been added to the Home Assistant documentation. Authored by Franck Nijhof, the post invites community members to share their experiences and feedback regarding the platform throughout December 2024. It includes a call to action for participation in discussions on a dedicated forum, emphasizes the importance of community input, and outlines the types of feedback being sought. The post also highlights improvements made to Home Assistant since the last edition of this initiative.

Changes

File Path Change Summary
source/_posts/2024-12-01-the-month-of-what-the-heck.markdown - New blog post added with title, author, and various metadata fields (description, date, categories, etc.).

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BlogPost
    participant Forum

    User->>BlogPost: Read "The month of 'What the Heck?!' 2024"
    BlogPost->>User: Invite to share experiences
    User->>Forum: Participate in discussions
    Forum->>User: Display feedback options
    User->>Forum: Submit feedback
    Forum->>BlogPost: Aggregate community feedback
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>, 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)
source/_posts/2024-12-01-the-month-of-what-the-heck.markdown (3)

76-81: Consider formatting the quote block

The quote block could be better formatted using markdown's native quote syntax for better readability and consistency.

-  > 🎅 𝘚𝘢𝘯𝘵𝘢 𝘮𝘪𝘨𝘩𝘵 𝘣𝘦 𝘭𝘪𝘴𝘵𝘦𝘯𝘪𝘯𝘨… If you could ask for one small Home Assistant
-  > improvement this holiday season, what would it be?
+> 🎅 *Santa might be listening…* If you could ask for one small Home Assistant
+> improvement this holiday season, what would it be?

163-209: Standardize emphasis style in FAQ section

The FAQ section uses underscores for emphasis while asterisks are used elsewhere. Consider standardizing to asterisks for consistency.

-  _"Great! I have multiple things! Should I put all my stuff in a single
-  topic?!"_
+  *"Great! I have multiple things! Should I put all my stuff in a single
+  topic?!"*
🧰 Tools
🪛 LanguageTool

[style] ~164-~164: Using many exclamation marks might seem excessive (in this case: 25 exclamation marks for a text that’s 7266 characters long)
Context: ... I put all my stuff in a single topic?!”_** No, please create **multiple...

(EN_EXCESSIVE_EXCLAMATION)


[uncategorized] ~176-~176: Possible missing preposition found.
Context: ...appen. The goal is to lower the barrier reporting things for one month. Code contributo...

(AI_HYDRA_LEO_MISSING_OF)


[style] ~179-~179: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ... to address. However, we have picked up a lot of items over the years (including bigge...

(A_LOT_OF)


[style] ~192-~192: Use ‘will’ instead of ‘going to’ if the following action is certain.
Context: ...pic is one of the top-voted ones, so it is going to be fixed/addressed, right?”_** Thi...

(GOING_TO_WILL)


[style] ~197-~197: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...or too big to implement. A topic with lots of votes is more likely to be noticed by a...

(A_LOT_OF)


[style] ~207-~207: ‘by all means’ might be wordy. Consider a shorter alternative.
Context: ...u are comfortable using GitHub, please, by all means, [file an issue report on GitHub] ins...

(EN_WORDINESS_PREMIUM_BY_ALL_MEANS)

🪛 Markdownlint (0.35.0)

163-163: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


164-164: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


173-173: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


173-173: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


184-184: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


185-185: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


192-192: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


193-193: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


204-204: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


205-205: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


211-211: Add newline at end of file

The file should end with a single newline character.

 [file an issue report on GitHub]: https://github.com/home-assistant/core/issues/new/choose
+
🧰 Tools
🪛 Markdownlint (0.35.0)

211-211: null
Files should end with a single newline character

(MD047, single-trailing-newline)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between dcf3f16 and 1445ea1.

⛔ Files ignored due to path filters (1)
  • source/images/blog/2024-12-01-the-month-of-what-the-heck/social.jpg is excluded by !**/*.jpg
📒 Files selected for processing (1)
  • source/_posts/2024-12-01-the-month-of-what-the-heck.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_posts/2024-12-01-the-month-of-what-the-heck.markdown

[uncategorized] ~29-~29: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ..., as of this year, we are also [the #1 open source project on GitHub]! A lot has happened...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[formatting] ~53-~53: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...### Lowering the barrier for sharing WTH?! moments We realize reporting bugs on o...

(DOUBLE_PUNCTUATION_PREMIUM)


[style] ~67-~67: The phrase ‘talk about’ can be informal. To elevate your writing, consider using a more professional alternative.
Context: ...gory] as a safe, lower-barrier place to talk about your Home Assistant “What the heck?!” m...

(TALK_ABOUT_DISCUSS)


[style] ~82-~82: The phrase ‘pretty much’ can be informal. To strengthen your writing, consider removing it or replacing it with an adverb.
Context: ...ld it be? The answers to this question pretty much capture the goal behind this month: Fin...

(PRETTY_MUCH)


[typographical] ~100-~100: A comma is not needed after quotations ending in either question marks or exclamation points.
Context: ...opics for the month of “What the heck?!”, I hope they inspire you for more topics...

(COMMA_AFTER_QUESTION_QUOTE)


[uncategorized] ~146-~146: Possible missing comma found.
Context: ...sharing your WTH! 👆That title says it all really. Start sharing your “What th...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~164-~164: Using many exclamation marks might seem excessive (in this case: 25 exclamation marks for a text that’s 7266 characters long)
Context: ... I put all my stuff in a single topic?!”_** No, please create **multiple...

(EN_EXCESSIVE_EXCLAMATION)


[uncategorized] ~176-~176: Possible missing preposition found.
Context: ...appen. The goal is to lower the barrier reporting things for one month. Code contributo...

(AI_HYDRA_LEO_MISSING_OF)


[style] ~179-~179: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ... to address. However, we have picked up a lot of items over the years (including bigge...

(A_LOT_OF)


[style] ~192-~192: Use ‘will’ instead of ‘going to’ if the following action is certain.
Context: ...pic is one of the top-voted ones, so it is going to be fixed/addressed, right?”_** Thi...

(GOING_TO_WILL)


[style] ~197-~197: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...or too big to implement. A topic with lots of votes is more likely to be noticed by a...

(A_LOT_OF)


[style] ~207-~207: ‘by all means’ might be wordy. Consider a shorter alternative.
Context: ...u are comfortable using GitHub, please, by all means, [file an issue report on GitHub] ins...

(EN_WORDINESS_PREMIUM_BY_ALL_MEANS)

🪛 Markdownlint (0.35.0)
source/_posts/2024-12-01-the-month-of-what-the-heck.markdown

126-126: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


144-144: Punctuation: '!'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


12-12: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


211-211: null
Files should end with a single newline character

(MD047, single-trailing-newline)


163-163: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


164-164: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


173-173: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


173-173: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


184-184: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


185-185: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


192-192: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


193-193: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


204-204: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)


205-205: Expected: asterisk; Actual: underscore
Emphasis style

(MD049, emphasis-style)

🔇 Additional comments (2)
source/_posts/2024-12-01-the-month-of-what-the-heck.markdown (2)

9-9: Verify social image existence

Let's ensure the referenced social image exists at the specified path.

✅ Verification successful

Social image exists at the specified path

The image file exists at source/images/blog/2024-12-01-the-month-of-what-the-heck/social.jpg, which matches the path referenced in the frontmatter (accounting for the source prefix). The image is properly placed and accessible.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the social image exists
fd -t f "social.jpg" images/blog/2024-12-01-the-month-of-what-the-heck/

Length of output: 209


Script:

#!/bin/bash
# Let's first check if the images directory exists and its structure
fd -t d "images"

# Also check for any .jpg files in the repository that might match our target
fd -t f -e jpg

Length of output: 9482


4-4: Verify date consistency

The post date (2024-11-30) differs from the formatted date (December 1, 2024) and the filename date (2024-12-01). While this might be intentional for scheduling, please confirm if this is the desired behavior.

Also applies to: 5-5

✅ Verification successful

Based on the search results, I can now generate a final response as I have enough information to verify the date pattern. The results show that having a post date one day before the formatted date is a common and intentional pattern in the blog posts, particularly for scheduled posts. For example:

Date pattern is consistent with blog post scheduling practices

The date discrepancy between the post date (2024-11-30) and the formatted date (December 1, 2024) follows an established pattern used throughout the blog for scheduling posts. This allows posts to be published at midnight in their target timezone while maintaining consistent date formatting for readers.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if this date pattern is consistent with other blog posts
rg -l "^date: .*\ndate_formatted:" source/_posts/

Length of output: 243


Script:

#!/bin/bash
# Check date patterns in blog posts with multiline mode
rg -U "date: .*\ndate_formatted:" source/_posts/

# Also check general date format usage
rg "^date: " source/_posts/

# List all blog post files to understand naming convention
fd . source/_posts/ -e markdown

Length of output: 101236

@frenck frenck merged commit 556ad9d into current Nov 30, 2024
9 checks passed
@frenck frenck deleted the frenck-2024-0584 branch November 30, 2024 19:58
@github-actions github-actions bot locked and limited conversation to collaborators Dec 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
blog This PR adds a blog article to the Home Assistant website current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants