Skip to content

Commit f7cd0d4

Browse files
authored
docs: fix broken descriptions (cube-js#10617)
* docs: fix broken markdown links in frontmatter descriptions Mintlify renders description as plain text subtitle, so markdown reference links [text][ref] displayed as raw syntax. Replaced with plain text across 41 pages. Made-with: Cursor * docs: reorganize folder structure and update navigation - Rename docs/caching to docs/pre-aggregations - Rename admin/deployment/monitoring to admin/monitoring/monitoring-integrations - Move account & billing pages into admin/account-billing folder - Move support page from deployment to account-billing - Add sidebarTitle to monitoring integration pages - Use root property for all API groups in docs.json - Update all cross-references across 100+ files Made-with: Cursor
1 parent 7d2473f commit f7cd0d4

144 files changed

Lines changed: 256 additions & 5303 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs-mintlify/admin/pricing.mdx renamed to docs-mintlify/admin/account-billing/pricing.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ the [speed and scope of support][ref-support] you may receive for your deploymen
2020
You can also set [Budgets][ref-cloud-budgets] to make sure you know your usage
2121
is on track and as expected.
2222

23-
[ref-cloud-budgets]: /admin/budgets
23+
[ref-cloud-budgets]: /admin/account-billing/budgets
2424
## Payment plans
2525

2626
Payment plans determine whether you have a fixed-term contract or a recurring
@@ -343,7 +343,7 @@ for the AI token consumption at the **Billing** page of their Cube Cloud account
343343
[ref-cloud-deployment-prod-cluster]: /docs/deployment/cloud/deployment-types#production-cluster
344344
[ref-cloud-limits]: /docs/deployment/cloud/limits
345345
[ref-monitoring-integrations]: /docs/monitoring/integrations
346-
[ref-monitoring-integrations-config]: /admin/deployment/monitoring#configuration
346+
[ref-monitoring-integrations-config]: /admin/deployment/monitoring-integrations#configuration
347347
[ref-cloud-acl]: /admin/users-and-permissions/custom-roles
348348
[ref-cloud-deployment-prod-multicluster]: /docs/deployment/cloud/deployment-types#production-multi-cluster
349349
[ref-cloud-custom-domains]: /docs/deployment/cloud/custom-domains
@@ -365,8 +365,8 @@ for the AI token consumption at the **Billing** page of their Cube Cloud account
365365
[ref-apis]: /reference
366366
[ref-mdx-api]: /reference/mdx-api
367367
[ref-dax-api]: /reference/dax-api
368-
[ref-cube-store-architecture]: /docs/caching/running-in-production#architecture
369-
[ref-data-at-rest-encryption]: /docs/caching/running-in-production#data-at-rest-encryption
368+
[ref-cube-store-architecture]: /docs/pre-aggregations/running-in-production#architecture
369+
[ref-data-at-rest-encryption]: /docs/pre-aggregations/running-in-production#data-at-rest-encryption
370370
[ref-customer-managed-keys]: /admin/deployment/encryption-keys
371371
[ref-semantic-catalog]: /docs/workspace/semantic-catalog
372-
[ref-query-history-export]: /admin/deployment/monitoring#query-history-export
372+
[ref-query-history-export]: /admin/deployment/monitoring-integrations#query-history-export

docs-mintlify/admin/deployment/support.mdx renamed to docs-mintlify/admin/account-billing/support.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Support in Cube Cloud
3+
sidebarTitle: Support
34
description: Summarizes support channels, coverage hours, and ticket allowances across Cube Cloud product tiers.
45
---
56

@@ -109,9 +110,9 @@ We prioritize support requests based on their severity, as follows:
109110
[ref-docs-intro]: /docs/introduction
110111
[cube-webinars]: https://cube.dev/events
111112
[cube-slack]: https://slack.cube.dev
112-
[ref-cloud-pricing]: /admin/pricing
113-
[ref-free-tier]: /admin/pricing#free
114-
[ref-starter-tier]: /admin/pricing#starter
115-
[ref-premium-tier]: /admin/pricing#premium
116-
[ref-enterprise-tier]: /admin/pricing#enterprise
117-
[ref-enterprise-premier-tier]: /admin/pricing#enterprise-premier
113+
[ref-cloud-pricing]: /admin/account-billing/pricing
114+
[ref-free-tier]: /admin/account-billing/pricing#free
115+
[ref-starter-tier]: /admin/account-billing/pricing#starter
116+
[ref-premium-tier]: /admin/account-billing/pricing#premium
117+
[ref-enterprise-tier]: /admin/account-billing/pricing#enterprise
118+
[ref-enterprise-premier-tier]: /admin/account-billing/pricing#enterprise-premier

docs-mintlify/admin/connect-to-data/concurrency.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Querying concurrency
3-
description: "All queries to [data APIs][ref-data-apis] are processed asynchronously via a _query queue_. It allows to optimize the load and increase querying performance."
3+
description: "All queries to data APIs are processed asynchronously via a query queue. It allows to optimize the load and increase querying performance."
44
---
55

66
## Query queue
@@ -78,7 +78,7 @@ However, you can override this behvaior in the refresh worker
7878
[ref-data-sources]: /admin/connect-to-data/data-sources
7979
[ref-context-to-orchestrator-id]: /reference/configuration/config#context_to_orchestrator_id
8080
[ref-driver-factory]: /reference/configuration/config#driver_factory
81-
[ref-preagg-refresh]: /docs/caching/refreshing-pre-aggregations#configuration
81+
[ref-preagg-refresh]: /docs/pre-aggregations/refreshing-pre-aggregations#configuration
8282
[ref-athena]: /admin/connect-to-data/data-sources/aws-athena
8383
[ref-clickhouse]: /admin/connect-to-data/data-sources/clickhouse
8484
[ref-databricks]: /admin/connect-to-data/data-sources/databricks-jdbc

docs-mintlify/admin/connect-to-data/data-sources/aws-athena.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ connections are made over HTTPS.
169169
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions
170170
[aws-athena-docs-approx-agg-fns]:
171171
https://prestodb.io/docs/current/functions/aggregate.html#approximate-aggregate-functions
172-
[ref-caching-large-preaggs]: /docs/caching/using-pre-aggregations#export-bucket
173-
[ref-caching-using-preaggs-build-strats]: /docs/caching/using-pre-aggregations#pre-aggregation-build-strategies
172+
[ref-caching-large-preaggs]: /docs/pre-aggregations/using-pre-aggregations#export-bucket
173+
[ref-caching-using-preaggs-build-strats]: /docs/pre-aggregations/using-pre-aggregations#pre-aggregation-build-strategies
174174
[ref-schema-ref-types-formats-countdistinctapprox]: /reference/data-modeling/measures#type
175175
[self-preaggs-batching]: #batching

docs-mintlify/admin/connect-to-data/data-sources/aws-redshift.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,8 @@ Database][ref-recipe-enable-ssl].
193193
[aws-vpc]: https://aws.amazon.com/vpc/
194194
[aws-docs-regions]:
195195
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions
196-
[ref-caching-large-preaggs]: /docs/caching/using-pre-aggregations#export-bucket
197-
[ref-caching-using-preaggs-build-strats]: /docs/caching/using-pre-aggregations#pre-aggregation-build-strategies
196+
[ref-caching-large-preaggs]: /docs/pre-aggregations/using-pre-aggregations#export-bucket
197+
[ref-caching-using-preaggs-build-strats]: /docs/pre-aggregations/using-pre-aggregations#pre-aggregation-build-strategies
198198
[ref-recipe-enable-ssl]: /recipes/configuration/using-ssl-connections-to-data-source
199199
[ref-schema-ref-types-formats-countdistinctapprox]: /reference/data-modeling/measures#type
200200
[self-preaggs-batching]: #batching

docs-mintlify/admin/connect-to-data/data-sources/clickhouse.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,11 +135,11 @@ You can connect to a ClickHouse database with compression enabled, by setting
135135
[clickhouse-docs-users]:
136136
https://clickhouse.tech/docs/en/operations/settings/settings-users/
137137
[clickhouse-readonly]: https://clickhouse.com/docs/en/operations/settings/permissions-for-queries#readonly
138-
[ref-caching-using-preaggs-build-strats]: /docs/caching/using-pre-aggregations#pre-aggregation-build-strategies
138+
[ref-caching-using-preaggs-build-strats]: /docs/pre-aggregations/using-pre-aggregations#pre-aggregation-build-strategies
139139
[ref-recipe-enable-ssl]: /recipes/configuration/using-ssl-connections-to-data-source
140-
[ref-caching-large-preaggs]: /docs/caching/using-pre-aggregations#export-bucket
140+
[ref-caching-large-preaggs]: /docs/pre-aggregations/using-pre-aggregations#export-bucket
141141
[ref-schema-ref-types-formats-countdistinctapprox]: /reference/data-modeling/measures#type
142142
[self-preaggs-batching]: #batching
143-
[ref-preaggs]: /docs/caching/using-pre-aggregations
143+
[ref-preaggs]: /docs/pre-aggregations/using-pre-aggregations
144144
[ref-preaggs-indexes]: /reference/data-modeling/pre-aggregations#indexes
145145
[ref-preaggs-rollup-join]: /reference/data-modeling/pre-aggregations#rollup_join

docs-mintlify/admin/connect-to-data/data-sources/databricks-jdbc.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ bucket][self-preaggs-export-bucket] **must be** configured.
199199
[databricks-catalog]: https://docs.databricks.com/en/data-governance/unity-catalog/create-catalogs.html
200200
[gh-cubejs-jdbc-install]:
201201
https://github.com/cube-js/cube/blob/master/packages/cubejs-jdbc-driver/README.md#java-installation
202-
[ref-caching-using-preaggs-build-strats]: /docs/caching/using-pre-aggregations#pre-aggregation-build-strategies
202+
[ref-caching-using-preaggs-build-strats]: /docs/pre-aggregations/using-pre-aggregations#pre-aggregation-build-strategies
203203
[ref-schema-ref-types-formats-countdistinctapprox]: /reference/data-modeling/measures#type
204204
[databricks-docs-approx-agg-fns]: https://docs.databricks.com/en/sql/language-manual/functions/approx_count_distinct.html
205205
[self-preaggs-simple]: #simple

0 commit comments

Comments
 (0)