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.

Sign up for GitHub

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

Jump to bottom

Add esphome platform to OTA sections in docs #3983

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Add esphome platform to OTA sections in docs #3983

merged 1 commit into from
Jun 25, 2024

Conversation

hmmbob
Copy link
Contributor

@hmmbob hmmbob commented Jun 23, 2024

Description:

Add esphome platform to OTA sections in docs. I've searched for ota: and added the platform anywhere it seemed to be missing to ensure that example code is right.

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#

Checklist:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /index.rst when creating new documents for new components or cookbook.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 23, 2024 •
edited
Loading

Walkthrough

The primary change involves adding the configuration parameter platform: esphome under the ota section across various components and guide files within ESPHome documentation. This enhancement standardizes the OTA configuration by specifying the platform, making configurations more consistent and readable.

Changes

Files/Paths Summary
components/bluetooth_proxy.rst Added platform: esphome under ota for Olimex ESP32-PoE-ISO board.
components/display/inkplate6.rst Added platform: esphome under ota in the Wi-Fi, API, and OTA configuration.
components/light/sonoff_d1.rst Added platform: esphome under ota for Sonoff D1.
components/output/my9231.rst Added platform: esphome under ota for Sonoff B1 and AiThinker AiLight.
components/output/sm16716.rst Added platform: esphome under ota for Feit Electric A19.
cookbook/arduino_port_extender.rst, guides/creators.rst Added platform: esphome under ota in API configuration and guides/creators respectively.
cookbook/leak-detector-m5stickC.rst, cookbook/sonoff-fishpond-pump.rst Added platform: esphome under ota for ESPHome configurations in cookbook entries.
Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cd4db33 and 68e06c6.

Files selected for processing (9)
  • components/bluetooth_proxy.rst (1 hunks)
  • components/display/inkplate6.rst (1 hunks)
  • components/light/sonoff_d1.rst (1 hunks)
  • components/output/my9231.rst (2 hunks)
  • components/output/sm16716.rst (1 hunks)
  • cookbook/arduino_port_extender.rst (1 hunks)
  • cookbook/leak-detector-m5stickC.rst (1 hunks)
  • cookbook/sonoff-fishpond-pump.rst (1 hunks)
  • guides/creators.rst (1 hunks)
Files skipped from review due to trivial changes (5)
  • components/bluetooth_proxy.rst
  • components/display/inkplate6.rst
  • components/output/my9231.rst
  • cookbook/arduino_port_extender.rst
  • cookbook/sonoff-fishpond-pump.rst
Additional context used
Gitleaks
guides/creators.rst

56-57: Identified a HashiCorp Terraform password field, risking unauthorized infrastructure configuration and security breaches. (hashicorp-tf-password)

components/light/sonoff_d1.rst

63-64: Identified a HashiCorp Terraform password field, risking unauthorized infrastructure configuration and security breaches. (hashicorp-tf-password)

Additional comments not posted (4)
guides/creators.rst (1)

46-46: Standardization of OTA configuration approved.

The addition of platform: esphome under the ota section aligns with the objective to standardize the configuration across various documentation files.

components/light/sonoff_d1.rst (1)

74-74: Standardization of OTA configuration approved.

The addition of platform: esphome under the ota section aligns with the objective to standardize the configuration across various documentation files.

components/output/sm16716.rst (1)

111-111: Standardization of OTA configuration approved.

The addition of platform: esphome under the ota section aligns with the objective to standardize the configuration across various documentation files.

cookbook/leak-detector-m5stickC.rst (1)

132-132: Standardization of OTA configuration approved.

The addition of platform: esphome under the ota section aligns with the objective to standardize the configuration across various documentation files.

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.

@netlify Netlify
Copy link

netlify bot commented Jun 23, 2024

✅ Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 68e06c6
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/667819b4606c180008c8fac4
😎 Deploy Preview https://deploy-preview-3983--esphome.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.

@nagyrobi
Copy link
Member

nagyrobi commented Jun 23, 2024 •
edited
Loading

I'd actually remove ota: and all stuff that's not directly related to the documented components, except from the cookbook.

@hmmbob
Copy link
Contributor Author

hmmbob commented Jun 23, 2024 •
edited
Loading

That would be a major overhaul of the docs, because in most occurrences they're part of "complete sample configurations". ota should be there as much as api, logger, etc.

Examples:

image
image
image
image

@nagyrobi
Copy link
Member

Such complete config examples should only be shown in the cookbook section of the doc site.

@hmmbob
Copy link
Contributor Author

hmmbob commented Jun 23, 2024

I can take a swing at that later, but I wont have time for that today/tomorrow. Is it an idea to merge this PR now (as it fixes documentation that as of 2024.6 is invalid) and move the moving to the cookbooks into a separate PR?

@nagyrobi
Copy link
Member

@kbx81

jesserockz
jesserockz approved these changes Jun 25, 2024
View reviewed changes
Copy link
Member

@jesserockz jesserockz left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks!

@nagyrobi While I agree with you, and they should be moved to https://devices.esphome.io (not cookbooks) This PR fixes broken examples which is fine to merge.

@jesserockz jesserockz merged commit 7f5479b into esphome:current Jun 25, 2024
2 checks passed
@hmmbob hmmbob deleted the add-platform-to-ota branch June 25, 2024 04:49
@jesserockz jesserockz mentioned this pull request Jun 26, 2024
Merged
@github-actions github-actions bot locked and limited conversation to collaborators Jun 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jesserockz jesserockz jesserockz approved these changes

Assignees
No one assigned
Labels
current
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@hmmbob @nagyrobi @jesserockz