home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Published 20 hours ago • verified publisher icon home-assistant

feat: vultr api upgrade docs

Open danleyb2 opened this issue 1 year ago • 4 comments

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).
  • [x] 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: https://github.com/home-assistant/core/pull/116507
  • 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

  • Documentation
    • Updated terminology in the Vultr integration documentation from "Vultr subscriptions" to "Vultr instances" to ensure consistency and clarity.
    • Adjusted descriptions and configurations related to monitoring and controlling Vultr instances within Home Assistant.

danleyb2 avatar Jun 17 '24 10:06 danleyb2

Walkthrough

Walkthrough

The update involves standardizing terminology within the Vultr integration documentation by replacing "Vultr subscriptions" with "Vultr instances." This alteration ensures consistency in referencing Vultr resources, impacting descriptions, configurations, and internal entity names within Home Assistant. The changes aim to improve clarity and usability for monitoring and controlling Vultr resources.

Changes

File Change Summary
.../_integrations/vultr.markdown Updated terminology from "Vultr subscriptions" to "Vultr instances" in descriptions, configurations, and entity names.
Recent review details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between aea35ff0aada30a51bffe58645172ff946597984 and 2caaca5fbe8ce62b3a895998b9dbf290990ee092.

Files selected for processing (1)
  • source/_integrations/vultr.markdown (5 hunks)
Additional context used
LanguageTool
source/_integrations/vultr.markdown

[misspelling] ~22-~22: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... title: Configuration file --- The Vultr {% term integration %} allows you to ...

[misspelling] ~22-~22: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...formation about and interact with your Vultr instances (Virt...

[duplication] ~26-~26: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE) Context: ...types within Home Assistant: - Binary sensor - Sensor - Switch ## Confi...

[misspelling] ~32-~32: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...uration Obtain your API key from your [Vultr Account](https://my.vultr.com/settings/...

[misspelling] ~38-~38: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...trol heading. To integrate your Vultr instances with Home Assistant, add the ...

[misspelling] ~44-~44: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...inclusion.md %} ## Binary sensor The vultr binary sensor platform allows you to m...

[misspelling] ~44-~44: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...or platform allows you to monitor your Vultr instance to se...

[style] ~44-~44: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal). (IF_WHETHER) Context: ...https://www.vultr.com/) instance to see if it is powered on or not. ### Configura...

[misspelling] ~53-~53: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... Minimal configuration.yaml (produces binary_sensor.vultr_web_server): ```yaml # Example config...

[misspelling] ~63-~63: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...stance: 123456 ``` {% configuration %} api_key: description: Your Vultr API key....

[misspelling] ~65-~65: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...uration %} api_key: description: Your Vultr API key. required: true type: strin...

[typographical] ~66-~66: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...y: description: Your Vultr API key. required: true type: string instance: descri...

[typographical] ~70-~70: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...und in the URL when viewing a server. required: true type: string name: descriptio...

[typographical] ~74-~74: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... you want to give this binary sensor. required: false default: "Vultr {instance labe...

[misspelling] ~75-~75: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...y sensor. required: false default: "Vultr {instance label}" type: string {% end...

[misspelling] ~77-~77: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ltr {instance label}" type: string {% endconfiguration %} ### Full example Full {% term "`co...

[misspelling] ~92-~92: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... instance: 12345 ``` ## Sensor The vultr sensor platform will allow you to view...

[misspelling] ~92-~92: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...lance and pending charges against your Vultr account. Mini...

[misspelling] ~94-~94: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...erm "configuration.yaml" %} (produces sensor.vultr_account_balance, `sensor.vultr_current...

[misspelling] ~94-~94: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...roduces sensor.vultr_account_balance, sensor.vultr_current_bandwidth_in, `sensor.vultr_cu...

[misspelling] ~94-~94: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ..., sensor.vultr_current_bandwidth_in, sensor.vultr_current_bandwidth_outandsensor.vult...

[misspelling] ~94-~94: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...sensor.vultr_current_bandwidth_outandsensor.vultr_pending_charges`): ```yaml sensor: -...

[misspelling] ~102-~102: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...Vultr API key. ``` {% configuration %} api_key: description: Your Vultr API key....

[misspelling] ~104-~104: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...uration %} api_key: description: Your Vultr API key. required: true type: strin...

[typographical] ~105-~105: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...y: description: Your Vultr API key. required: true type: string name: descriptio...

[typographical] ~109-~109: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...iption: The name to give this sensor. required: false default: "Vultr {Vultr instanc...

[misspelling] ~110-~110: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...s sensor. required: false default: "Vultr {Vultr instance label} {monitored condi...

[misspelling] ~110-~110: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...r. required: false default: "Vultr {Vultr instance label} {monitored condition na...

[typographical] ~114-~114: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...you want to monitor for each account. required: false detault: All conditions type...

[misspelling] ~115-~115: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...r for each account. required: false detault: All conditions type: list keys: ...

[misspelling] ~118-~118: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ype: list keys: current_bandwidth_gb_in: description: The current (inv...

[typographical] ~120-~120: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... bandwidth usage in Gigabytes (GB). current_bandwidth_gb_out: description: Th...

[misspelling] ~120-~120: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...n Gigabytes (GB). current_bandwidth_gb_out: description: The current (in...

[typographical] ~122-~122: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...bandwidth usage out Gigabytes (GB). pending_charges: description: The current...

[typographical] ~124-~124: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...ount. Value is in US Dollars (US$). balance: description: The current account...

[misspelling] ~126-~126: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...lance. Value is in US Dollars (US$). {% endconfiguration %} Full {% term "configuration.yaml"...

[misspelling] ~142-~142: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... only one condition monitored (produces sensor.account_current_bandwidth_gb_in): ```yaml sensor: - platform: vu...

[misspelling] ~155-~155: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ent_bandwidth_gb_in ``` ## Switch The vultr switch platform allows you to control ...

[misspelling] ~155-~155: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...llows you to control (start/stop) your Vultr instance. ###...

[misspelling] ~159-~159: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...erm "configuration.yaml" %} (produces switch.vultr_web_server): ```yaml # Example config...

[misspelling] ~169-~169: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...UR_INSTANCE_ID ``` {% configuration %} api_key: description: Your Vultr API key....

[misspelling] ~171-~171: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...uration %} api_key: description: Your Vultr API key. required: true type: strin...

[typographical] ~172-~172: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...y: description: Your Vultr API key. required: true type: string instance: descri...

[typographical] ~176-~176: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...ption: The instance you want control. required: true type: string name: descriptio...

[typographical] ~180-~180: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...he name you want to give this switch. required: false default: "Vultr {instance labe...

[misspelling] ~181-~181: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...s switch. required: false default: "Vultr {instance label}" type: string {% end...

[misspelling] ~183-~183: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ltr {instance label}" type: string {% endconfiguration %} ### Additional examples Full examp...

Markdownlint
source/_integrations/vultr.markdown

41-41: Expected: 1; Actual: 2 (MD012, no-multiple-blanks) Multiple consecutive blank lines

46-46: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings) Headings should be surrounded by blank lines

34-34: Element: div (MD033, no-inline-html) Inline HTML

47-47: Element: div (MD033, no-inline-html) Inline HTML

Additional comments not posted (6)
source/_integrations/vultr.markdown (6)

22-22: Update the integration description to reflect the terminology changes accurately.

Tools
LanguageTool

[misspelling] ~22-~22: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... title: Configuration file --- The Vultr {% term integration %} allows you to ...

[misspelling] ~22-~22: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...formation about and interact with your Vultr instances (Virt...

38-38: Ensure that the integration instructions are clear and concise.

Tools
LanguageTool

[misspelling] ~38-~38: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...trol heading. To integrate your Vultr instances with Home Assistant, add the ...

44-44: Consider simplifying the description of the binary sensor's functionality for clarity.

Tools
LanguageTool

[misspelling] ~44-~44: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...inclusion.md %} ## Binary sensor The vultr binary sensor platform allows you to m...

[misspelling] ~44-~44: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...or platform allows you to monitor your Vultr instance to se...

[style] ~44-~44: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal). (IF_WHETHER) Context: ...https://www.vultr.com/) instance to see if it is powered on or not. ### Configura...

92-92: Verify that all sensor descriptions and configurations reflect the new terminology consistently.

Also applies to: 94-94

Tools
LanguageTool

[misspelling] ~92-~92: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... instance: 12345 ``` ## Sensor The vultr sensor platform will allow you to view...

[misspelling] ~92-~92: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...lance and pending charges against your Vultr account. Mini...

155-155: Confirm that the switch configuration descriptions accurately reflect the capabilities and use the updated terminology.

Tools
LanguageTool

[misspelling] ~155-~155: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ent_bandwidth_gb_in ``` ## Switch The vultr switch platform allows you to control ...

[misspelling] ~155-~155: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...llows you to control (start/stop) your Vultr instance. ###...

Line range hint 22-195: Overall, ensure that the document is consistent in terminology and clear in instructions.

Verification successful

The search for the term "subscription" in the source/_integrations/vultr.markdown file did not produce any output, indicating that the term is not present in the context of Vultr integration.

  • No occurrences of "subscription" were found in the file.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any outdated terminology not updated in this PR.

# Test: Search for "subscription". Expect: No occurrences in the context of Vultr.
rg --type markdown 'subscription' source/_integrations/vultr.markdown

Length of output: 69

Tools
LanguageTool

[misspelling] ~92-~92: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... instance: 12345 ``` ## Sensor The vultr sensor platform will allow you to view...

[misspelling] ~92-~92: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...lance and pending charges against your Vultr account. Mini...

[misspelling] ~94-~94: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...erm "configuration.yaml" %} (produces sensor.vultr_account_balance, `sensor.vultr_current...

[misspelling] ~94-~94: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...roduces sensor.vultr_account_balance, sensor.vultr_current_bandwidth_in, `sensor.vultr_cu...

[misspelling] ~94-~94: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ..., sensor.vultr_current_bandwidth_in, sensor.vultr_current_bandwidth_outandsensor.vult...

[misspelling] ~94-~94: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...sensor.vultr_current_bandwidth_outandsensor.vultr_pending_charges`): ```yaml sensor: -...

[misspelling] ~102-~102: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...Vultr API key. ``` {% configuration %} api_key: description: Your Vultr API key....

[misspelling] ~104-~104: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...uration %} api_key: description: Your Vultr API key. required: true type: strin...

[typographical] ~105-~105: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...y: description: Your Vultr API key. required: true type: string name: descriptio...

[typographical] ~109-~109: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...iption: The name to give this sensor. required: false default: "Vultr {Vultr instanc...

[misspelling] ~110-~110: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...s sensor. required: false default: "Vultr {Vultr instance label} {monitored condi...

[misspelling] ~110-~110: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...r. required: false default: "Vultr {Vultr instance label} {monitored condition na...

[typographical] ~114-~114: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...you want to monitor for each account. required: false detault: All conditions type...

[misspelling] ~115-~115: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...r for each account. required: false detault: All conditions type: list keys: ...

[misspelling] ~118-~118: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ype: list keys: current_bandwidth_gb_in: description: The current (inv...

[typographical] ~120-~120: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ... bandwidth usage in Gigabytes (GB). current_bandwidth_gb_out: description: Th...

[misspelling] ~120-~120: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...n Gigabytes (GB). current_bandwidth_gb_out: description: The current (in...

[typographical] ~122-~122: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...bandwidth usage out Gigabytes (GB). pending_charges: description: The current...

[typographical] ~124-~124: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START) Context: ...ount. Value is in US Dollars (US$). balance: description: The current account...

[misspelling] ~126-~126: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...lance. Value is in US Dollars (US$). {% endconfiguration %} Full {% term "configuration.yaml"...

[misspelling] ~142-~142: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ... only one condition monitored (produces sensor.account_current_bandwidth_gb_in): ```yaml sensor: - platform: vu...

[misspelling] ~155-~155: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...ent_bandwidth_gb_in ``` ## Switch The vultr switch platform allows you to control ...

[misspelling] ~155-~155: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...llows you to control (start/stop) your Vultr instance. ###...

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.

coderabbitai[bot] avatar Jun 17 '24 10:06 coderabbitai[bot]

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit 2caaca5fbe8ce62b3a895998b9dbf290990ee092
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66700c1b08ee290009496ca1
Deploy Preview https://deploy-preview-33300--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.

netlify[bot] avatar Jun 17 '24 10:06 netlify[bot]

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[bot] avatar Jun 18 '24 06:06 home-assistant[bot]

Thank you for contributing, @danleyb2 :+1:

As this PR seems to be related to a code PR, please rebase and point this PR against the next branch.

c0ffeeca7 avatar Jun 19 '24 04:06 c0ffeeca7

Closing PR as the parent PR has been closed.

frenck avatar Aug 08 '24 17:08 frenck