Skip to content

Update unifi.markdown#33552

Merged
frenck merged 1 commit into
home-assistant:currentfrom
dmares01:patch-2
Jul 5, 2024
Merged

Update unifi.markdown#33552
frenck merged 1 commit into
home-assistant:currentfrom
dmares01:patch-2

Conversation

@dmares01
Copy link
Copy Markdown
Contributor

@dmares01 dmares01 commented Jul 3, 2024

This adds a small tweak to point out the port number for self hosted Unifi servers. Although not necessary I believe this is worth pointing out to help people streamline their configuration setup

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

  • Documentation
    • Updated UniFi OS documentation to specify the port number distinction between UniFi OS devices and self-hosted servers.

This adds a small tweak to point out the port number for self hosted unifi servers
@dmares01 dmares01 requested a review from Kane610 as a code owner July 3, 2024 21:47
@home-assistant home-assistant Bot added the current This PR goes into the current branch label Jul 3, 2024
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 3, 2024

Walkthrough

Walkthrough

The recent modification addresses the specification of port numbers for UniFi OS users. It clarifies how users with devices upgraded to UniFi OS and those with self-hosted servers should approach port settings. No public APIs or exported entities were altered.

Changes

File Change Summary
source/_integrations/unifi... Updated information on specifying port numbers for UniFi OS users, differentiating between UniFi OS and self-hosted servers.

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 65fb594 and c535eb0.

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

[misspelling] ~54-~54: Possible spelling mistake found.
Context: ... need to have 'admin' permissions. ### UniFi OS For UniFi OS a local-only user need...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~56-~56: Possible spelling mistake found.
Context: ...'admin' permissions. ### UniFi OS For UniFi OS a local-only user needs to be create...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~56-~56: Possible spelling mistake found.
Context: ...eeds to be created. A user who uses the Ubiquiti cloud will not work. You can do this in...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~56-~56: Possible spelling mistake found.
Context: ...this in the manage users section on the UniFi OS dashboard. Make sure to give it the ...

(MORFOLOGIK_RULE_EN_US)


[uncategorized] ~56-~56: Possible missing comma found.
Context: ...ions for the functions you want to use. Note the Dream Machine Pro and Cloud Key Gen...

(AI_HYDRA_LEO_MISSING_COMMA)


[misspelling] ~56-~56: Possible spelling mistake found.
Context: ... Pro and Cloud Key Gen2 plus updated to UniFi OS needs the port to be 443. For some s...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~56-~56: This word is normally spelled with a hyphen.
Context: ...i OS needs the port to be 443. For some self hosted servers the port will be 8443. ### Con...

(EN_COMPOUNDS_SELF_HOSTED)


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
Copy link
Copy Markdown

netlify Bot commented Jul 3, 2024

Deploy Preview for home-assistant-docs ready!

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

Copy link
Copy Markdown
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

### UniFi OS

For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note the Dream Machine Pro and Cloud Key Gen2 plus updated to UniFi OS needs the port to be 443.
For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note the Dream Machine Pro and Cloud Key Gen2 plus updated to UniFi OS needs the port to be 443. For some self hosted servers the port will be 8443.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Fix spelling and grammatical errors.

There are several spelling and grammatical errors in this segment. Here is the corrected version:

- For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note the Dream Machine Pro and Cloud Key Gen2 plus updated to UniFi OS needs the port to be 443. For some self hosted servers the port will be 8443.
+ For UniFi OS, a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note that the Dream Machine Pro and Cloud Key Gen2 Plus, updated to UniFi OS, need the port to be 443. For some self-hosted servers, the port will be 8443.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
For UniFi OS a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note the Dream Machine Pro and Cloud Key Gen2 plus updated to UniFi OS needs the port to be 443. For some self hosted servers the port will be 8443.
For UniFi OS, a local-only user needs to be created. A user who uses the Ubiquiti cloud will not work. You can do this in the manage users section on the UniFi OS dashboard. Make sure to give it the right permissions for the functions you want to use. Note that the Dream Machine Pro and Cloud Key Gen2 Plus, updated to UniFi OS, need the port to be 443. For some self-hosted servers, the port will be 8443.
Tools
LanguageTool

[misspelling] ~56-~56: Possible spelling mistake found.
Context: ...'admin' permissions. ### UniFi OS For UniFi OS a local-only user needs to be create...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~56-~56: Possible spelling mistake found.
Context: ...eeds to be created. A user who uses the Ubiquiti cloud will not work. You can do this in...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~56-~56: Possible spelling mistake found.
Context: ...this in the manage users section on the UniFi OS dashboard. Make sure to give it the ...

(MORFOLOGIK_RULE_EN_US)


[uncategorized] ~56-~56: Possible missing comma found.
Context: ...ions for the functions you want to use. Note the Dream Machine Pro and Cloud Key Gen...

(AI_HYDRA_LEO_MISSING_COMMA)


[misspelling] ~56-~56: Possible spelling mistake found.
Context: ... Pro and Cloud Key Gen2 plus updated to UniFi OS needs the port to be 443. For some s...

(MORFOLOGIK_RULE_EN_US)


[misspelling] ~56-~56: This word is normally spelled with a hyphen.
Context: ...i OS needs the port to be 443. For some self hosted servers the port will be 8443. ### Con...

(EN_COMPOUNDS_SELF_HOSTED)

@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Jul 4, 2024
Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @dmares01 👍

../Frenck

@frenck frenck merged commit 0938360 into home-assistant:current Jul 5, 2024
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 6, 2024
@dmares01 dmares01 deleted the patch-2 branch July 8, 2024 20:56
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 smash Indicator this PR is close to finish for merging or closing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants