From 9b8eda5d1c02b7b71c74727ab4fd684e5171c51b Mon Sep 17 00:00:00 2001 From: Danielle9897 Date: Wed, 16 Sep 2026 15:08:24 +0300 Subject: [PATCH 1/2] RDoc-4066 Licensing & usage - fixes --- quill/dashboard/certificates.mdx | 4 ++-- quill/dashboard/license.mdx | 15 +++++++++------ quill/dashboard/my-apps.mdx | 9 +++++---- quill/dashboard/usage.mdx | 26 ++++++++++++++++++-------- quill/getting-started/signing-up.mdx | 10 ++++++++-- 5 files changed, 42 insertions(+), 22 deletions(-) diff --git a/quill/dashboard/certificates.mdx b/quill/dashboard/certificates.mdx index 45aeb8235b..b8a34856d4 100644 --- a/quill/dashboard/certificates.mdx +++ b/quill/dashboard/certificates.mdx @@ -314,8 +314,8 @@ The app selector lists the apps in your Quill instance by app name. #### Read-only access is not available -* RavenDB supports a **Read** access level, - but the Quill Dashboard does not offer it when generating or editing certificates. +* RavenDB supports a **Read** access level, but the current Quill license does not include read-only certificates. + The Quill Dashboard therefore does not offer **Read** when generating or editing certificates. * A User certificate created in RavenDB Studio with **Read** access still appears in the Dashboard, with **Read** displayed under **APP ACCESS**. When you open the certificate in the **Edit** dialog, the access-level selector for that row has no selection. diff --git a/quill/dashboard/license.mdx b/quill/dashboard/license.mdx index 79f4b7b175..3b26d18e9a 100644 --- a/quill/dashboard/license.mdx +++ b/quill/dashboard/license.mdx @@ -17,9 +17,12 @@ import ContentFrame from "@site/src/components/ContentFrame"; * Use this page to view the license expiration date and ID, open **Support**, review available plans, and check connectivity to RavenDB's licensing API. +* The Quill license includes the RavenDB capabilities required by the appliance; it does not include every RavenDB Server feature. + For example, it does not include [read-only certificates](certificates.mdx#read-only-access-is-not-available). + You do not need to obtain or install a separate RavenDB Server license. + * You cannot install or change a license from this page. - To view write usage associated with the license, select **Usage** under **License & usage**. - {/* TODO: link to usage.mdx */} + To view write usage associated with the license, open the [Usage](../dashboard/usage.mdx) view under **License & usage**. * In this article: * [License overview](#license-overview) @@ -79,7 +82,8 @@ The **Available plans** section displays the available plan information. It is marked **Coming soon**, and the plan cards are disabled. You cannot select or purchase a plan from this page. -To install or change a license, contact RavenDB sales. +To install or change a license, contact RavenDB sales. +For current plan details and pricing, see [Quill pricing](https://ravendb.net/quill/pricing). @@ -114,8 +118,7 @@ Your Quill deployment uses RavenDB's licensing API to: * **Report and retrieve write usage.** RavenDB reports write usage approximately every 15 minutes. - The **Usage** page retrieves the aggregated write usage from the same API. - {/* TODO: link to usage.mdx */} + The [**Usage**](../dashboard/usage.mdx) view retrieves the aggregated write usage from the same API. **Connectivity and license validity are separate**: a failed connectivity check does not remove the installed license. @@ -135,4 +138,4 @@ The **License** page does not continuously poll for updates. * If the license information cannot be loaded, "**Could not load license**" appears in place of the page content. Select **Retry** to request the information again. - \ No newline at end of file + diff --git a/quill/dashboard/my-apps.mdx b/quill/dashboard/my-apps.mdx index 07fdd3a580..ac6f5d424b 100644 --- a/quill/dashboard/my-apps.mdx +++ b/quill/dashboard/my-apps.mdx @@ -97,9 +97,10 @@ Hovering over a point shows the bucket's date; in the Day view, it also shows th including input and output tokens. 5. **WRU** - **Write Request Unit** - a measure of write activity in each app's RavenDB database. - * WRU includes writes made when Quill [mirrors](../overview.mdx#mirroring) changes from source databases, records conversations, - and when applications write [directly with the RavenDB Client API](../overview.mdx#working-with-quill-using-code). + **Write Request Unit (WRU)** is the billing unit Quill uses for metered write activity. + This tile totals WRU reported for the RavenDB databases belonging to the current apps. + * It does not include **@system** configuration-storage usage, usage from other Quill deployments sharing the license, or historical databases that no longer belong to a current app. + * For the billing rules and examples of writes that count, see [Write usage (WRU)](usage.mdx#write-usage-wru). * Write usage is reported every 15 minutes, so recent writes may not be included yet. @@ -172,4 +173,4 @@ Until the first app is added, the table is replaced by **No apps added yet** and The source relational database and its data are **not** deleted. To confirm, enter the app's name. This action cannot be undone. - \ No newline at end of file + diff --git a/quill/dashboard/usage.mdx b/quill/dashboard/usage.mdx index be8c9adb71..f305c66350 100644 --- a/quill/dashboard/usage.mdx +++ b/quill/dashboard/usage.mdx @@ -11,7 +11,9 @@ import ContentFrame from "@site/src/components/ContentFrame"; -* The **Usage** view shows write activity reported under the installed Quill license, measured in **Write Request Units (WRU)**. +* The **Usage** view shows write activity reported under the installed Quill license, + measured in **Write Request Units (WRU)**. + Open it under **License & usage** in the dashboard sidebar, at `https://dashboard./usage`. * This is a **license-wide** view. If the same license is used by more than one Quill deployment, @@ -66,19 +68,24 @@ import ContentFrame from "@site/src/components/ContentFrame"; ### What WRU counts -**Write Request Unit (WRU)** is the unit used to measure write activity in the RavenDB databases reported under your Quill license. +**Write Request Unit (WRU)** is the billing unit Quill uses for metered write activity. +Under Quill's pricing model, each document insert, update, or delete counts as one WRU, regardless of document size or ingestion speed. -Sources of write activity include: +Writes that count include: -* Quill [mirroring](../overview.mdx#mirroring) changes from a source relational database to an app's RavenDB database. -* Quill storing conversations in an app's RavenDB database. +* Quill's initial import and later [mirroring](../overview.mdx#mirroring) of changes from a source relational database to an app's RavenDB database. +* Quill storing conversation messages in an app's RavenDB database. +* Generating embeddings for app data, which Quill's pricing model counts as writes rather than internal index maintenance. * Applications writing directly to an app database with [the RavenDB Client API](../overview.mdx#working-with-quill-using-code). * Quill writing to its own configuration storage, shown in the table as [@system](#usage-per-app). +Reads, queries, and the indexes Quill maintains internally are not metered. +For current WRU billing rules and published plan allowances, see [Quill pricing](https://ravendb.net/quill/pricing). + Usage is reported every 15 minutes, so recent write activity may not appear immediately. For details about the installed license and its connectivity to RavenDB's licensing API, -open [**License**](../dashboard/license.mdx) under **License & usage**. +open the [**License**](../dashboard/license.mdx) view under **License & usage**. @@ -182,8 +189,11 @@ When no usage was reported for the selected period, the table displays **No usag -The Usage view shows write usage already reported under the installed license. -It does not display a quota, remaining allowance, or usage cap. +The Usage view shows write usage already reported under the installed license. +It does not show the plan associated with the license, its included WRU volume, the remaining allowance, or resulting charges. + +For published plan allowances and pricing, see [Quill pricing](https://ravendb.net/quill/pricing). +To confirm the terms of your installed license, contact RavenDB sales. * The view does not poll for updates. Reload the page, or leave the view and return later, to request newer figures. diff --git a/quill/getting-started/signing-up.mdx b/quill/getting-started/signing-up.mdx index 76755e6490..1d65c2695a 100644 --- a/quill/getting-started/signing-up.mdx +++ b/quill/getting-started/signing-up.mdx @@ -59,7 +59,8 @@ Before signing up, make sure you have: -Signing up starts a 90-day free trial. +Signing up starts a 90-day free trial. No credit card or sales call is required, and WRU usage is unlimited during the trial. +For current plan details, see [Quill pricing](https://ravendb.net/quill/pricing). Open [ravendb.net/quill/start](https://ravendb.net/quill/start), fill in the form, and confirm your email address with the code Quill sends you. @@ -185,7 +186,12 @@ All the details that are displayed here are also sent to the email address you p **bash** or **PowerShell** form. The Docker command already includes both the license key and the dashboard API key, so you do not have to add these keys separately. - See more about the Docker command in [Starting Quill](../getting-started/starting-quill.mdx). + + * The license key retrieves the setup package for the registered domain. + * The dashboard API key, by contrast, belongs to the signup account and is normally shared by Quill instances + registered under the same email address. See [One key per account](../security-and-architecture/operator-authentication.mdx#one-key-per-account). + + Learn more about the Docker command in [Starting Quill](../getting-started/starting-quill.mdx). 4. **Once Quill is running** The address of your management dashboard, and the steps that follow: connecting your data, mapping it, and From 642b516be2462c43fe15510b3220d199575d1a6e Mon Sep 17 00:00:00 2001 From: Danielle9897 Date: Wed, 16 Sep 2026 17:43:00 +0300 Subject: [PATCH 2/2] RDoc-4066 fix review comment --- quill/getting-started/signing-up.mdx | 5 +++-- quill/security-and-architecture/operator-authentication.mdx | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/quill/getting-started/signing-up.mdx b/quill/getting-started/signing-up.mdx index 1d65c2695a..8e7db4ab53 100644 --- a/quill/getting-started/signing-up.mdx +++ b/quill/getting-started/signing-up.mdx @@ -188,8 +188,9 @@ All the details that are displayed here are also sent to the email address you p these keys separately. * The license key retrieves the setup package for the registered domain. - * The dashboard API key, by contrast, belongs to the signup account and is normally shared by Quill instances - registered under the same email address. See [One key per account](../security-and-architecture/operator-authentication.mdx#one-key-per-account). + * The dashboard API key, by contrast, belongs to the signup account. + The same key is issued for every Quill domain registered under the same email address. + See [One key per account](../security-and-architecture/operator-authentication.mdx#one-key-per-account). Learn more about the Docker command in [Starting Quill](../getting-started/starting-quill.mdx). diff --git a/quill/security-and-architecture/operator-authentication.mdx b/quill/security-and-architecture/operator-authentication.mdx index b428040d20..a864edf680 100644 --- a/quill/security-and-architecture/operator-authentication.mdx +++ b/quill/security-and-architecture/operator-authentication.mdx @@ -138,10 +138,10 @@ See [the Quill hostnames](network-architecture.mdx#the-quill-hostnames). -The Dashboard API key issued during signup belongs to the signup account, not to an individual Quill instance. -The same key is issued for every Quill instance registered under the same email address. +The Dashboard API key issued during signup belongs to the signup account, not to an individual Quill domain. +The same key is issued for every Quill domain registered under the same email address. -By default, you configure each of those Quill instances with the signup-issued key: +By default, each corresponding Quill instance is configured with the signup-issued key: * Every Quill instance that is still configured with that key accepts it.