RDoc-2600 Describe RavenDB Cloud Product Features #1895
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PFYasu
reviewed
Sep 17, 2024
|
|
||
| {PANEL: OLAP ETL } | ||
|
|
||
| RavenDB Cloud provides OLAP ETL capabilities, allowing you to integrate your operational data with analytical data |
There was a problem hiding this comment.
Suggested change
| RavenDB Cloud provides OLAP ETL capabilities, allowing you to integrate your operational data with analytical data | |
| *RavenDB Cloud* provides *OLAP ETL* capabilities, allowing you to integrate your operational data with analytical data |
PFYasu
reviewed
Sep 17, 2024
|
|
||
| {PANEL: PowerBi } | ||
|
|
||
| RavenDB Cloud supports direct integration with Power BI, a leading business analytics tool. This feature allows you |
There was a problem hiding this comment.
Suggested change
| RavenDB Cloud supports direct integration with Power BI, a leading business analytics tool. This feature allows you | |
| *RavenDB Cloud* supports direct integration with *Power BI*, a leading business analytics tool. This feature allows you |
PFYasu
reviewed
Sep 17, 2024
| {PANEL: PowerBi } | ||
|
|
||
| RavenDB Cloud supports direct integration with Power BI, a leading business analytics tool. This feature allows you | ||
| to seamlessly connect your RavenDB data with Power BI for advanced visualization and reporting, enabling real-time |
There was a problem hiding this comment.
Suggested change
| to seamlessly connect your RavenDB data with Power BI for advanced visualization and reporting, enabling real-time | |
| to seamlessly connect your *RavenDB* data with *Power BI* for advanced visualization and reporting, enabling real-time |
PFYasu
reviewed
Sep 17, 2024
| ## Configuration | ||
|
|
||
| {WARNING: Required } | ||
| PowerBi IPs must be configured after enabling PowerBi feature. |
There was a problem hiding this comment.
Suggested change
| PowerBi IPs must be configured after enabling PowerBi feature. | |
| *Power BI* IPs must be configured **after** enabling *Power BI* feature. |
PFYasu
reviewed
Sep 17, 2024
| PowerBi IPs must be configured after enabling PowerBi feature. | ||
| {WARNING/} | ||
|
|
||
| To access PowerBi Configuration View click **Configure** Button in PowerBi Feature Row. Here you can edit your IP |
There was a problem hiding this comment.
Suggested change
| To access PowerBi Configuration View click **Configure** Button in PowerBi Feature Row. Here you can edit your IP | |
| To access *Power BI* Configuration View click **Configure** Button in *Power BI* feature row. Here you can edit your IP |
PFYasu
reviewed
Sep 17, 2024
| {WARNING/} | ||
|
|
||
| To access PowerBi Configuration View click **Configure** Button in PowerBi Feature Row. Here you can edit your IP | ||
| addresses that will have access to RavenDB PowerBi port. |
There was a problem hiding this comment.
Suggested change
| addresses that will have access to RavenDB PowerBi port. | |
| addresses that will have access to *RavenDB Power BI* port. |
PFYasu
reviewed
Sep 17, 2024
| To access PowerBi Configuration View click **Configure** Button in PowerBi Feature Row. Here you can edit your IP | ||
| addresses that will have access to RavenDB PowerBi port. | ||
|
|
||
|  |
There was a problem hiding this comment.
Suggested change
|  | |
|  |
PFYasu
reviewed
Sep 17, 2024
|  | ||
|
|
||
| {INFO: } | ||
| PowerBi IPs entries are [CIDR ranges](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) |
There was a problem hiding this comment.
Suggested change
| PowerBi IPs entries are [CIDR ranges](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) | |
| *Power BI* IPs entries are [CIDR ranges](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation) |
PFYasu
reviewed
Sep 17, 2024
|
|
||
| {PANEL: Queue ETL } | ||
|
|
||
| The Queue ETL feature enables you to export data from RavenDB to various queue systems, such as RabbitMQ or Kafka. |
There was a problem hiding this comment.
Suggested change
| The Queue ETL feature enables you to export data from RavenDB to various queue systems, such as RabbitMQ or Kafka. | |
| The *Queue ETL* feature enables you to export data from *RavenDB* to various queue systems, such as *RabbitMQ* or *Kafka*. |
PFYasu
reviewed
Sep 17, 2024
|
|
||
| {PANEL: Queue Sink } | ||
|
|
||
| Queue Sink allows RavenDB Cloud to directly receive data from queues, making it easier to ingest data into your |
There was a problem hiding this comment.
Suggested change
| Queue Sink allows RavenDB Cloud to directly receive data from queues, making it easier to ingest data into your | |
| *Queue Sink* allows *RavenDB Cloud* to directly receive data from queues, making it easier to ingest data into your |
PFYasu
reviewed
Sep 17, 2024
| Usage of this feature is described [here](../server/ongoing-tasks/queue-sink/overview). | ||
|
|
||
| {INFO: Availability } | ||
| This feature is available only for RavenDB 6.0 and newer. |
There was a problem hiding this comment.
Suggested change
| This feature is available only for RavenDB 6.0 and newer. | |
| This feature is available only for *RavenDB* **6.0** and newer**. |
PFYasu
reviewed
Sep 17, 2024
|
|
||
| {PANEL: Data Archival } | ||
|
|
||
| RavenDB Cloud offers the ability to archive selected documents. |
There was a problem hiding this comment.
Suggested change
| RavenDB Cloud offers the ability to archive selected documents. | |
| *RavenDB Cloud* offers the ability to archive selected documents. |
PFYasu
reviewed
Sep 17, 2024
| {PANEL: Data Archival } | ||
|
|
||
| RavenDB Cloud offers the ability to archive selected documents. | ||
| Archived documents are compressed and can be handled differently by RavenDB functions (e.g. Indexing can exclude |
There was a problem hiding this comment.
Suggested change
| Archived documents are compressed and can be handled differently by RavenDB functions (e.g. Indexing can exclude | |
| Archived documents are compressed and can be handled differently by *RavenDB* functions (e.g. Indexing can exclude |
PFYasu
reviewed
Sep 17, 2024
| Usage of this feature is described [here](../server/extensions/archival). | ||
|
|
||
| {INFO: Availability } | ||
| This feature is available only for RavenDB 6.0 and newer. |
There was a problem hiding this comment.
Suggested change
| This feature is available only for RavenDB 6.0 and newer. | |
| This feature is available only for *RavenDB* **6.0** and newer**. |
PFYasu
reviewed
Sep 17, 2024
|
|
||
| {PANEL: Monitoring } | ||
|
|
||
| RavenDB Cloud allows you to monitor your RavenDB Cloud instances via SNMP protocol. SNMP is a widely used network |
There was a problem hiding this comment.
Suggested change
| RavenDB Cloud allows you to monitor your RavenDB Cloud instances via SNMP protocol. SNMP is a widely used network | |
| *RavenDB Cloud* allows you to monitor your *RavenDB Cloud* instances via *SNMP* protocol. *SNMP* is a widely used network |
PFYasu
reviewed
Sep 17, 2024
|
|
||
| ## Configuration | ||
|
|
||
| Click **Configure** Button in Monitoring Feature Row in order to configure this feature. |
There was a problem hiding this comment.
Suggested change
| Click **Configure** Button in Monitoring Feature Row in order to configure this feature. | |
| Click **Configure** Button in *Monitoring* feature row in order to configure this feature. |
PFYasu
reviewed
Sep 17, 2024
| ### SNMP Monitoring IPs | ||
|
|
||
| {WARNING: Required } | ||
| SNMP Monitoring IPs must be configured after enabling Monitoring feature. |
There was a problem hiding this comment.
Suggested change
| SNMP Monitoring IPs must be configured after enabling Monitoring feature. | |
| *SNMP Monitoring* IPs must be configured **after** enabling *Monitoring* feature. |
PFYasu
reviewed
Sep 17, 2024
| ### SNMPv3 Monitoring credentials | ||
|
|
||
| SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up | ||
| SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure |
There was a problem hiding this comment.
Suggested change
| SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure | |
| SNMPv3 monitoring for your *RavenDB Cloud* instances, you need to configure specific credentials that ensure secure |
PFYasu
reviewed
Sep 17, 2024
| SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure | ||
| communication between the SNMP agent on your end and the RavenDB. | ||
|
|
||
| Credentials required to connect to RavenDB Monitoring Endpoints are provided in this section. We also provide sample |
There was a problem hiding this comment.
Suggested change
| Credentials required to connect to RavenDB Monitoring Endpoints are provided in this section. We also provide sample | |
| Credentials required to connect to *RavenDB Monitoring* Endpoints are provided in this section. We also provide sample |
PFYasu
reviewed
Sep 17, 2024
| command you can use to test connection. | ||
|
|
||
| {INFO: } | ||
| SNMP Monitoring IPs entries |
There was a problem hiding this comment.
Suggested change
| SNMP Monitoring IPs entries | |
| *SNMP Monitoring* IPs entries |
PFYasu
reviewed
Sep 17, 2024
|
|
||
| SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up | ||
| SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure | ||
| communication between the SNMP agent on your end and the RavenDB. |
There was a problem hiding this comment.
Suggested change
| communication between the SNMP agent on your end and the RavenDB. | |
| communication between the *SNMP* agent on your end and the *RavenDB*. |
PFYasu
reviewed
Sep 17, 2024
|
|
||
| ### SNMPv3 Monitoring credentials | ||
|
|
||
| SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up |
There was a problem hiding this comment.
Suggested change
| SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up | |
| *SNMPv3* is the most secure version of *SNMP*, providing enhanced security features over its predecessors. When setting up |
PFYasu
reviewed
Sep 17, 2024
| ### SNMPv3 Monitoring credentials | ||
|
|
||
| SNMPv3 is the most secure version of SNMP, providing enhanced security features over its predecessors. When setting up | ||
| SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure |
There was a problem hiding this comment.
Suggested change
| SNMPv3 monitoring for your RavenDB Cloud instances, you need to configure specific credentials that ensure secure | |
| *SNMPv3* monitoring for your *RavenDB Cloud* instances, you need to configure specific credentials that ensure secure |
PFYasu
reviewed
Sep 17, 2024
| SNMP Monitoring IPs must be configured after enabling Monitoring feature. | ||
| {WARNING/} | ||
|
|
||
| This section allows you to specify IPs that will have access to your product using SNMP protocol. |
There was a problem hiding this comment.
Suggested change
| This section allows you to specify IPs that will have access to your product using SNMP protocol. | |
| This section allows you to specify IPs that will have access to your product using the *SNMP* protocol. |
PFYasu
suggested changes
Sep 17, 2024
| @@ -0,0 +1,117 @@ | |||
| # Cloud: Product Features | |||
There was a problem hiding this comment.
I would add a note about the impact of enabling / disabling the features. IIRC in general these actions restart the RavenDB service - we should notify about that by adding a WARNING section in the particular feature descriptions.
|
After the latest changes within the documentation, please consider rebasing onto master. |
hiddenshadow21
force-pushed
the
RDoc-2600
branch
from
970f503
to
ba9c20c
Compare
PFYasu
approved these changes
Sep 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://issues.hibernatingrhinos.com/issue/RDoc-2600