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

docs: add instructions of how to register lovelace resources via yaml #2236

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

tobiasdiez
Copy link

@tobiasdiez tobiasdiez commented Jul 1, 2024

Proposed change

Add instructions of how to register lovelace resources via yaml

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Removed stale or deprecated documentation

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Summary by CodeRabbit

  • Documentation
    • Introduced an alternative method to register a resource in the lovelace configuration file with a provided YAML snippet.

Copy link
Contributor

coderabbitai bot commented Jul 1, 2024

Walkthrough

Walkthrough

The change introduces an alternative method for registering resources in the lovelace configuration file. It provides a YAML snippet demonstrating how to add resources to the resources section. This enhances the existing documentation by offering an additional option for users to configure their resources.

Changes

Files Change Summary
docs/frontend/custom-ui/registering-resources.md Added an alternative method to register a resource in lovelace using a YAML snippet in the config file. Understandable example provided.

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 18d8e23 and cd2b648.

Files selected for processing (1)
  • docs/frontend/custom-ui/registering-resources.md (1 hunks)
Additional context used
LanguageTool
docs/frontend/custom-ui/registering-resources.md

[uncategorized] ~5-~5: A comma might be missing here.
Context: ...erface with custom cards, strategies or views you need to load external resources. T...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[misspelling] ~7-~7: Possible spelling mistake found.
Context: ... directory in your config folder called www. Create this directory and restart Hom...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~23-~23: Possible spelling mistake found.
Context: ...adding it to the resources section of lovelace in the configuration: ```yaml resourc...

(MORFOLOGIK_RULE_EN_US)

Additional comments not posted (1)
docs/frontend/custom-ui/registering-resources.md (1)

23-23: Fix the typo in "thee".

The word "thee" should be "the".

- Alternatively, you can also register thee resource by adding it to the `resources` section of `lovelace` in the configuration:
+ Alternatively, you can also register the resource by adding it to the `resources` section of `lovelace` in the configuration:

Likely invalid or redundant comment.

Tools
LanguageTool

[misspelling] ~23-~23: Possible spelling mistake found.
Context: ...adding it to the resources section of lovelace in the configuration: ```yaml resourc...

(MORFOLOGIK_RULE_EN_US)


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

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 Configration 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: 2

Outside diff range comments (2)
docs/frontend/custom-ui/registering-resources.md (2)

Line range hint 5-5: Add a comma for correct punctuation.

A comma is missing after "strategies or views".

- If you want to extend the Home Assistant interface with custom cards, strategies or views you need to load external resources.
+ If you want to extend the Home Assistant interface with custom cards, strategies, or views, you need to load external resources.
Tools
LanguageTool

[misspelling] ~23-~23: Did you actually mean the archaic form of ‘you’, or did you maybe mean “the”?
Context: ...) Alternatively, you can also register thee resource by adding it to the `resources...

(THEE)


[misspelling] ~23-~23: Possible spelling mistake found.
Context: ...adding it to the resources section of lovelace in the configuration: ```yaml resource...

(MORFOLOGIK_RULE_EN_US)

Markdownlint

24-24: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)


Line range hint 7-7: Fix the typo in "Hom".

The word "Hom" should be "Home".

- Create this directory and restart Hom Assistant.
+ Create this directory and restart Home Assistant.
Tools
LanguageTool

[misspelling] ~23-~23: Did you actually mean the archaic form of ‘you’, or did you maybe mean “the”?
Context: ...) Alternatively, you can also register thee resource by adding it to the `resources...

(THEE)


[misspelling] ~23-~23: Possible spelling mistake found.
Context: ...adding it to the resources section of lovelace in the configuration: ```yaml resource...

(MORFOLOGIK_RULE_EN_US)

Markdownlint

24-24: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

docs/frontend/custom-ui/registering-resources.md Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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: 3

Outside diff range comments (1)
docs/frontend/custom-ui/registering-resources.md (1)

Line range hint 11-11: Add the missing article "the".

The sentence is missing the article "the" before "below link".

- This is done by navigating to the Resources page by following below link:
+ This is done by navigating to the Resources page by following the below link:
Tools
LanguageTool

[misspelling] ~23-~23: Possible spelling mistake found.
Context: ...adding it to the resources section of lovelace in the configuration: ```yaml resource...

(MORFOLOGIK_RULE_EN_US)

Markdownlint

24-24: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

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

@piitaya
Copy link
Member

piitaya commented Jul 5, 2024

Hi 👋
Thank you the contribution. According to dashboards documentation, the resources are only available when the dashboard is in yaml mode, right?
May be we can just link to Home Assistant documentation to explain how the register ressources when the dashboard are in yaml mode.

@tobiasdiez
Copy link
Author

To be honest, I don't have much experience with resources in HA. While installing one dashboard plugin, I came across the instruction to "register the resource" and had to consult a few resources to finally figure it out. Thus this PR.

Happy to move it to a more appropriate page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants