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

picture cards: add person image support #32733

Merged
merged 3 commits into from
Jul 23, 2024

Conversation

Quentame
Copy link
Member

@Quentame Quentame commented May 13, 2024

Proposed change

Add doc for home-assistant/frontend#20593

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
    • Introduced an optional image_entity field across various dashboard configurations, allowing users to specify an image or person entity for display. This enhances visual representation and flexibility.
  • Documentation
    • Clarified the description of the entity_id field, specifying that it can refer to a camera, image, or person, improving user understanding of its context.

@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 May 13, 2024
Copy link

netlify bot commented May 13, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 42beff1
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/669e7cbacca94800084c19dd
😎 Deploy Preview https://deploy-preview-32733--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
Copy link

Hey there @home-assistant/frontend, mind taking a look at this feedback as it has been labeled with an integration (frontend) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of frontend can trigger bot actions by commenting:

  • @home-assistant close Closes the feedback.
  • @home-assistant rename Awesome new title Renames the feedback.
  • @home-assistant reopen Reopen the feedback.
  • @home-assistant unassign frontend Removes the current integration label and assignees on the feedback, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information) to the feedback.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information) on the feedback.

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.

Tiny tweak

@home-assistant home-assistant bot marked this pull request as draft May 14, 2024 05:18
@home-assistant
Copy link

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.

@Quentame Quentame force-pushed the picture-card/add_person_support branch from 95eedca to cd9247a Compare May 16, 2024 20:17
@Quentame Quentame marked this pull request as ready for review May 16, 2024 20:19
@home-assistant home-assistant bot requested a review from c0ffeeca7 May 16, 2024 20:19
c0ffeeca7
c0ffeeca7 previously approved these changes May 17, 2024
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, @Quentame 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label May 17, 2024
Copy link
Contributor

@silamon silamon left a comment

Choose a reason for hiding this comment

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

During code review of the frontend pr, it became clear that image_entity looks for an entity to use the image from in both the picture elements card and picture glance card. Therefore person_entity and image_entity have been combined into image_entity to prevent having a separate option for each supported entity type. Image_entity can be either an image or a person entity.

Copy link
Contributor

coderabbitai bot commented Jul 22, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

Walkthrough

The recent updates introduce a new optional field, image_entity, across several markdown files related to dashboard configurations. This field allows users to specify an image or person entity, enhancing flexibility and usability in displaying visual elements. Additionally, the description of the existing entity field has been clarified to specify that it can represent a camera, image, or person. Overall, these changes improve user experience by broadening the types of entities that can be represented visually.

Changes

Files Change Summary
source/_dashboards/picture-elements.markdown, source/_dashboards/picture-glance.markdown, source/_dashboards/picture.markdown Added a new optional field, image_entity, allowing specification of an image or person entity for display.
source/_dashboards/picture-entity.markdown Enhanced the description of the entity field to clarify that it can refer to a camera, image, or person.

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.

@Quentame Quentame force-pushed the picture-card/add_person_support branch from 9d250d5 to 42beff1 Compare July 22, 2024 15:37
@piitaya piitaya added parent-merged The parent PR has been merged already and removed awaits-parent Awaits the merge of an parent PR labels Jul 23, 2024
@frenck frenck merged commit e5f1aef into home-assistant:next Jul 23, 2024
6 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Jul 23, 2024
@Quentame Quentame deleted the picture-card/add_person_support branch July 23, 2024 12:04
@github-actions github-actions bot locked and limited conversation to collaborators Jul 24, 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 integration: frontend next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants