addition: list of entities #39421
addition: list of entities #39421
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 Walkthrough""" WalkthroughThe documentation for the Nextcloud integration in Home Assistant has been updated to include a comprehensive section detailing all entities created by the integration. This new section enumerates the specific update entity, various sensors, and diagnostic sensors, categorizing them by their default enablement status and the metrics they provide. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation updates. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/nextcloud.markdown (4)
38-46: Streamline the introduction of entities
Reword the repetitive "For each entry, the integration will create" phrasing for clarity. For example:- ## Entities - - For each entry, the integration will create the following entities. + ## Entities + + When you configure a Nextcloud server, the integration creates the following entities:
47-68: Use 'Number of' for countable sensors & reorder CPU load list
'Amount of' is better reserved for mass nouns; switch to 'Number of' for countable items and list CPU load intervals in ascending order:- - Amount of files + - Number of files - - Amount of shares + - Number of shares - - Amount of storages + - Number of storages - - Amount of user + - Number of users - - CPU load last 1 minute - - CPU load last 15 minutes - - CPU load last 5 minutes + - CPU load last 1 minute + - CPU load last 5 minutes + - CPU load last 15 minutes🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...n will create the following sensors. - Amount of files - Amount of shares - Amount of...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~52-~52: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...following sensors. - Amount of files - Amount of shares - Amount of storages - Amount...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~53-~53: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... - Amount of files - Amount of shares - Amount of storages - Amount of user - Apps ins...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~56-~56: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...unt of user - Apps installed - CPU load last 1 minute - CPU load last 15 minutes - C...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~57-~57: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...led - CPU load last 1 minute - CPU load last 15 minutes - CPU load last 5 minutes - ...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~58-~58: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...e - CPU load last 15 minutes - CPU load last 5 minutes - Database size - Free memory...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
69-101: Consistent 'Number of' terminology for diagnostic sensors (enabled by default)
Apply the same 'Number of' convention to diagnostic sensors that count entities and clarify time ranges:- - Amount of active users last 5 minutes + - Number of active users (last 5 minutes) - - Amount of active users last day + - Number of active users (last day) - - Amount of active users last hour + - Number of active users (last hour) - - Amount of group shares + - Number of group shares - - Amount of link shares + - Number of link shares🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...s link shares - Amount of room shares - Amount of shares received - Amount of shares s...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~86-~86: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...om shares - Amount of shares received - Amount of shares sent - Amount of storages at ...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~87-~87: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ares received - Amount of shares sent - Amount of storages at home - Amount of user sh...(AMOUNTOF_TO_NUMBEROF)
102-147: Consider sub-grouping diagnostic sensors (disabled by default)
The disabled-by-default list is extensive—consider breaking it into sub-sections (e.g., Cache, Interned, JIT, Opcache, SMA, Memcache) for readability or presenting it in a table.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/nextcloud.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nextcloud.markdown
[uncategorized] ~51-~51: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...n will create the following sensors. - Amount of files - Amount of shares - Amount of...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~52-~52: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...following sensors. - Amount of files - Amount of shares - Amount of storages - Amount...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~53-~53: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... - Amount of files - Amount of shares - Amount of storages - Amount of user - Apps ins...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~56-~56: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...unt of user - Apps installed - CPU load last 1 minute - CPU load last 15 minutes - C...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~57-~57: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...led - CPU load last 1 minute - CPU load last 15 minutes - CPU load last 5 minutes - ...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~58-~58: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...e - CPU load last 15 minutes - CPU load last 5 minutes - Database size - Free memory...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~85-~85: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...s link shares - Amount of room shares - Amount of shares received - Amount of shares s...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~86-~86: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...om shares - Amount of shares received - Amount of shares sent - Amount of storages at ...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~87-~87: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ares received - Amount of shares sent - Amount of storages at home - Amount of user sh...
(AMOUNTOF_TO_NUMBEROF)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Hi @h8hr1pzdo3rmiqv5
thx for this contribution to the documentation 👍
I think we can skip the "Entities" chapter and just add one for "Sensor" (don't distinguish between sensors and diagnostic sensors in the chapters, but maybe in the table -see below-) and one for the "Update entity". With this we would avoid repeating "For each entry, the integration will create...". Further all the sensors could be put into a table with a column for the "enabled by default"
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/nextcloud.markdown (2)
38-131: Consistent phrasing for countable metricsThe table uses “Amount of” for countable entities (e.g., users, files). Per English conventions and HA style, use “Number of” and plural nouns. Also consider adding “in the last” for time-bound metrics.
Example diff for the first few rows (apply analogously):
@@ -| Amount of active users last 5 minutes | yes | +| Number of active users in the last 5 minutes | yes | @@ -| Amount of active users last day | yes | +| Number of active users in the last day | yes | @@ -| Amount of files | yes | +| Number of files | yes | @@ -| Amount of user | yes | +| Number of users | yes |🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...unt of active users last hour | yes | | Amount of files | yes | | Amount of group shar...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~56-~56: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...yes | | Amount of room shares | yes | | Amount of shares | yes | | Amount of shares re...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~57-~57: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...es | yes | | Amount of shares | yes | | Amount of shares received | yes | | Amount of ...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~58-~58: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...| | Amount of shares received | yes | | Amount of shares sent | yes | | Amount of stor...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~59-~59: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...yes | | Amount of shares sent | yes | | Amount of storages | yes | | Amount of storage...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~60-~60: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... | yes | | Amount of storages | yes | | Amount of storages at home | yes | | Amount of...(AMOUNTOF_TO_NUMBEROF)
132-135: Improve update entity phrasingReword to active voice and align with existing sections.
## Update entity -An update entity will be created for each entry. +For each entry, an update entity is created.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/nextcloud.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nextcloud.markdown
[uncategorized] ~48-~48: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...unt of active users last hour | yes | | Amount of files | yes | | Amount of group shar...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~56-~56: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...yes | | Amount of room shares | yes | | Amount of shares | yes | | Amount of shares re...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~57-~57: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...es | yes | | Amount of shares | yes | | Amount of shares received | yes | | Amount of ...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~58-~58: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...| | Amount of shares received | yes | | Amount of shares sent | yes | | Amount of stor...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~59-~59: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...yes | | Amount of shares sent | yes | | Amount of storages | yes | | Amount of storage...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~60-~60: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... | yes | | Amount of storages | yes | | Amount of storages at home | yes | | Amount of...
(AMOUNTOF_TO_NUMBEROF)
Co-authored-by: Michael <[email protected]>
Co-authored-by: Michael <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
source/_integrations/nextcloud.markdown (2)
41-41: Applied previous suggestion: sensor introduction included
The line “For each entry, the integration will create the following {% term sensors %}:” matches the earlier recommended wording.
132-134: Applied previous suggestion: update entity note added
The sentence “An {% term update %} entity will be created for each entry.” correctly implements the earlier recommendation.
🧹 Nitpick comments (3)
source/_integrations/nextcloud.markdown (3)
38-42: Group under a parent 'Entities' section
To align with the structure used in other integrations, consider adding a top‐level## Entitiesheading before## Sensorsand## Update entity. This will clearly group all provided entities in one section and improve discoverability.
45-131: Inconsistent phrasing: use “Number of” with plural nouns
Most entries list discrete, countable objects. Replace “Amount of” with “Number of” and ensure plural noun forms (e.g., “users”).Apply a patch along these lines:
- | Amount of active users last 5 minutes | ✅ | + | Number of active users last 5 minutes | ✅ | - | Amount of active users last day | ✅ | + | Number of active users last day | ✅ | - | Amount of files | ✅ | + | Number of files | ✅ | ... (and so on for each “Amount of” row) ...🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...mount of active users last hour | ✅ | | Amount of files | ✅ | | Amount of group shares...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~56-~56: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...s | ✅ | | Amount of room shares | ✅ | | Amount of shares | ✅ | | Amount of shares rece...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~57-~57: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...shares | ✅ | | Amount of shares | ✅ | | Amount of shares received | ✅ | | Amount of sh...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~58-~58: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...✅ | | Amount of shares received | ✅ | | Amount of shares sent | ✅ | | Amount of storag...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~59-~59: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...d | ✅ | | Amount of shares sent | ✅ | | Amount of storages | ✅ | | Amount of storages ...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~60-~60: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...sent | ✅ | | Amount of storages | ✅ | | Amount of storages at home | ✅ | | Amount of u...(AMOUNTOF_TO_NUMBEROF)
45-131: Improve readability by categorizing sensors
With ~70 rows, the flat table can be overwhelming. Consider breaking it into thematic subsections (e.g., User statistics, Storage metrics, Cache statistics, PHP info) or using collapsible Markdown details to help users scan the list.🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...mount of active users last hour | ✅ | | Amount of files | ✅ | | Amount of group shares...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~56-~56: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...s | ✅ | | Amount of room shares | ✅ | | Amount of shares | ✅ | | Amount of shares rece...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~57-~57: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...shares | ✅ | | Amount of shares | ✅ | | Amount of shares received | ✅ | | Amount of sh...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~58-~58: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...✅ | | Amount of shares received | ✅ | | Amount of shares sent | ✅ | | Amount of storag...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~59-~59: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...d | ✅ | | Amount of shares sent | ✅ | | Amount of storages | ✅ | | Amount of storages ...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~60-~60: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...sent | ✅ | | Amount of storages | ✅ | | Amount of storages at home | ✅ | | Amount of u...(AMOUNTOF_TO_NUMBEROF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/nextcloud.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nextcloud.markdown
[uncategorized] ~48-~48: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...mount of active users last hour | ✅ | | Amount of files | ✅ | | Amount of group shares...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~56-~56: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...s | ✅ | | Amount of room shares | ✅ | | Amount of shares | ✅ | | Amount of shares rece...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~57-~57: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...shares | ✅ | | Amount of shares | ✅ | | Amount of shares received | ✅ | | Amount of sh...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~58-~58: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...✅ | | Amount of shares received | ✅ | | Amount of shares sent | ✅ | | Amount of storag...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~59-~59: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...d | ✅ | | Amount of shares sent | ✅ | | Amount of storages | ✅ | | Amount of storages ...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~60-~60: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...sent | ✅ | | Amount of storages | ✅ | | Amount of storages at home | ✅ | | Amount of u...
(AMOUNTOF_TO_NUMBEROF)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/nextcloud.markdown (1)
43-44: Clear table header
The column labels “Sensor” and “Enabled by default” are concise and accurately describe the contents.
Proposed change
Added the entities provided by the integration, in order to know them before adding the integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit