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

Upload blog for GitHub Universe 2024 #35817

Merged
merged 5 commits into from
Nov 18, 2024

Conversation

googanhiem
Copy link
Contributor

@googanhiem googanhiem commented Nov 18, 2024

Proposed change

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

  • New Features

    • Added a new community member, Missy Quarry, with her GitHub handle.
    • Introduced a detailed wrap-up post for the GitHub Universe '24 event, showcasing Home Assistant's achievements and community engagement.
  • Updates

    • Improved formatting for Andy Gill's entry in the people list.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Nov 18, 2024
Copy link

netlify bot commented Nov 18, 2024

Deploy Preview for home-assistant-docs ready!

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

googanhiem and others added 2 commits November 18, 2024 17:26
Thanks for those @frenck

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
@googanhiem googanhiem marked this pull request as ready for review November 18, 2024 18:11
Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

📝 Walkthrough

Walkthrough

The changes involve two primary updates: the addition of a new entry for "Missy Quarry" in the people.yml file and modifications to the existing entry for "Andy Gill." Additionally, a new markdown file titled 2024-11-18-event-wrapup-github-universe-24.markdown has been created, detailing the Home Assistant community's participation in the GitHub Universe '24 event. This file includes structured content such as a title, description, author information, and various sections highlighting the community's achievements and experiences during the event.

Changes

File Path Change Summary
source/_data/people.yml - Added new entry for "Missy Quarry" with GitHub handle missyquarry.
- Modified entry for "Andy Gill" to include a newline at the end of the file.
source/_posts/2024-11-18-event-wrapup-github-universe-24.markdown - Created new post with title, description, author, date, and categories.
- Included sections like "Community comes together," "We are number 1!," and "Open Source - ⭐️ of the show."
- Added Open Graph image path and comments setting.

Sequence Diagram(s)

sequenceDiagram
    participant Author as Missy Quarry
    participant Community as Home Assistant Community
    participant Event as GitHub Universe '24

    Author->>Event: Attends event
    Author->>Community: Coordinates community meetup
    Community->>Event: Engages at the booth
    Author->>Community: Shares experiences and achievements
    Author->>Event: Reflects on community engagement
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: 0

🧹 Outside diff range and nitpick comments (3)
source/_data/people.yml (1)

91-91: Add newline at end of file

Add a newline character at the end of the file to follow YAML best practices and make the file more git-friendly.

   github: missyquarry
+
🧰 Tools
🪛 yamllint

[error] 91-91: no new line character at the end of file

(new-line-at-end-of-file)

source/_posts/2024-11-18-event-wrapup-github-universe-24.markdown (2)

13-13: Enhance image accessibility

While all images have alt text, some could be more descriptive for better accessibility.

Consider these improvements:

  • Line 13: Add more context to alt text, e.g., "GitHub Universe 2024 Event Wrap-up banner"
  • Line 48: Enhance alt text to "Home Assistant ranked as number one open source project on GitHub"
  • Line 52: Add context to alt text, e.g., "Graph showing top five projects by contributors from GitHub Octoverse 2024 report"

Also applies to: 36-36, 40-40, 44-44, 48-48, 52-52, 56-56, 64-64, 70-70, 74-74, 78-78


46-46: Style and formatting improvements

A few minor suggestions to enhance readability and maintain documentation standards:

  1. Remove exclamation mark from heading "We are number 1!" to follow heading standards
  2. Add hyphens to compound adjectives:
-#1 open source project
+#1 open-source project
  1. Consider replacing informal "y'all" with "our community" or "our users" for consistency with documentation style

Also applies to: 66-66

🧰 Tools
🪛 Markdownlint

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

(MD026, no-trailing-punctuation)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 320b1cf and ce190ee.

⛔ Files ignored due to path filters (10)
  • source/images/blog/2024-11-universe/art.jpg is excluded by !**/*.jpg
  • source/images/blog/2024-11-universe/booth.jpg is excluded by !**/*.jpg
  • source/images/blog/2024-11-universe/day-1-keynote.jpg is excluded by !**/*.jpg
  • source/images/blog/2024-11-universe/ha-keynote.jpg is excluded by !**/*.jpg
  • source/images/blog/2024-11-universe/meetup-audience.jpg is excluded by !**/*.jpg
  • source/images/blog/2024-11-universe/number-1.png is excluded by !**/*.png
  • source/images/blog/2024-11-universe/octoverse-contributors.png is excluded by !**/*.png
  • source/images/blog/2024-11-universe/postcard-badge.png is excluded by !**/*.png
  • source/images/blog/2024-11-universe/shiny.png is excluded by !**/*.png
  • source/images/blog/2024-11-universe/wonderfully-welcoming.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • source/_data/people.yml (1 hunks)
  • source/_posts/2024-11-18-event-wrapup-github-universe-24.markdown (1 hunks)
🧰 Additional context used
🪛 yamllint
source/_data/people.yml

[error] 91-91: no new line character at the end of file

(new-line-at-end-of-file)

🪛 LanguageTool
source/_posts/2024-11-18-event-wrapup-github-universe-24.markdown

[style] ~15-~15: Consider using an extreme adjective for ‘big’.
Context: ... community growing, and there were some really big moments---our community meetup in San F...

(EXTREME_ADJECTIVES)


[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...f being in 2nd place, we are now the #1 open source project on GitHub with over 21,000 cont...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~30-~30: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...was this my first event as a part of an open source project, but it was also my first time ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[style] ~42-~42: Consider an alternative to strengthen your wording.
Context: ...k questions from the community members. It was great talking to everyone who attended - bein...

(NICE_MEETING_YOU)


[uncategorized] ~50-~50: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...d announce something new: we are the #1 open source project on GitHub by active contributor...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[style] ~50-~50: Consider using an extreme adjective for ‘interesting’.
Context: .../octoverse/octoverse-2024/), which is a really interesting read. <img src='/images/blog/2024-11-u...

(EXTREME_ADJECTIVES)


[style] ~54-~54: Consider a different adjective to strengthen your wording.
Context: ...se 2024 report"> Our friends at GitHub did a great job of making sure we were surprised by thi...

(DO_A_GREAT_JOB)


[uncategorized] ~66-~66: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... Day 1 is when we had our booth in the [Open Source Zone](https://github.blog/open-source/1...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~66-~66: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...-ching! How to attract funding for your open source projects](https://reg.githubuniverse.co...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[style] ~66-~66: The phrase ‘y’all’ is informal.
Context: ...story since Home Assistant is funded by y'all - the community - through our [Home Ass...

(Y_ALL)


[uncategorized] ~66-~66: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ns with several people working on other open source projects like Homebrew and Ladybird. O...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[style] ~76-~76: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...u going to build?

The guys did amazing up on stage! 🤩 It was wonderful to see...

(AWESOME)


[style] ~84-~84: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...# Connecting with the community It was an amazing event, and so nice to meet my colleague...

(AWESOME)


[uncategorized] ~86-~86: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...continuously growing - becoming the top open source project on the platform. The next time ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🪛 Markdownlint
source/_posts/2024-11-18-event-wrapup-github-universe-24.markdown

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

(MD026, no-trailing-punctuation)

🔇 Additional comments (4)
source/_data/people.yml (2)

87-88: LGTM! Proper spacing added

The added newline improves readability and maintains consistent formatting with other entries.


89-91: LGTM! Verify GitHub handle

The new entry follows the established format correctly.

✅ Verification successful

GitHub handle verified and confirmed

The GitHub handle missyquarry exists and matches the user's profile at Nabu Casa, confirming the correctness of the entry in people.yml.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify that the GitHub handle exists and is correctly spelled
gh api users/missyquarry > /dev/null

Length of output: 26


Script:

#!/bin/bash
# Let's try to get more information about the GitHub user
gh api users/missyquarry || echo "User not found"

# Also try with different casing since GitHub handles are case-insensitive
gh api users/MissyQuarry || echo "User not found"

Length of output: 2674

🧰 Tools
🪛 yamllint

[error] 91-91: no new line character at the end of file

(new-line-at-end-of-file)

source/_posts/2024-11-18-event-wrapup-github-universe-24.markdown (2)

1-11: Front matter looks good!

All required metadata fields are present and properly formatted.


19-24: Verify external link accessibility

The table of contents structure is good. Let's ensure all external links are accessible.

✅ Verification successful

External links and table of contents structure verified successfully

All external URLs in the blog post return HTTP 200 status codes, confirming they are accessible. The table of contents structure correctly matches the section headers with proper markdown anchor link syntax.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify external links in the blog post
# Test: Check if external URLs are accessible

# Extract and test URLs
urls=(
  "https://githubuniverse.com/"
  "https://github.blog/open-source/10-projects-in-the-open-source-zone-at-github-universe-2024/"
  "https://reg.githubuniverse.com/flow/github/universe24/attendee-portal/page/sessioncatalog/session/1715376172449001OEqW"
  "https://github.blog/news-insights/octoverse/octoverse-2024/"
)

for url in "${urls[@]}"; do
  echo "Testing: $url"
  curl -sL -w "%{http_code}\n" "$url" -o /dev/null
done

Length of output: 1620

Copy link
Contributor Author

@googanhiem googanhiem left a comment

Choose a reason for hiding this comment

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

Its ready to go

@balloob balloob merged commit 369c31e into home-assistant:current Nov 18, 2024
7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Nov 19, 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.

3 participants