Skip to content

Commit f053837

Browse files
authored
docs: restructure mintlify docs navigation and paths (cube-js#10586)
- Rename api-reference/ to reference/ and update all internal links - Move docs/data-modeling/reference/ to reference/data-modeling/ as first group in Reference tab - Move admin/configuration/reference/ to reference/configuration/ - Remove duplicate docs/configuration/ directory (mirrors admin/configuration/) - Add wildcard redirects for all relocated paths Made-with: Cursor
1 parent defc186 commit f053837

309 files changed

Lines changed: 2062 additions & 13742 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.

docs-mintlify/access-security/access-control/context.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -535,13 +535,13 @@ view(`total_revenue_per_customer`, {
535535

536536
[link-auth0-jwks]:
537537
https://auth0.com/docs/tokens/json-web-tokens/json-web-key-sets
538-
[link-multitenancy]: /docs/configuration/multitenancy
539-
[ref-config-queryrewrite]: /docs/configuration/reference/config#query_rewrite
540-
[ref-config-sched-refresh]: /docs/configuration/reference/config#scheduledrefreshcontexts
541-
[ref-config-sec-ctx]: /docs/configuration/reference/config#securitycontext
542-
[ref-cubes-compile-ctx]: /docs/data-modeling/reference/context-variables#compile_context
538+
[link-multitenancy]: /admin/configuration/multitenancy
539+
[ref-config-queryrewrite]: /reference/configuration/config#query_rewrite
540+
[ref-config-sched-refresh]: /reference/configuration/config#scheduledrefreshcontexts
541+
[ref-config-sec-ctx]: /reference/configuration/config#securitycontext
542+
[ref-cubes-compile-ctx]: /reference/data-modeling/context-variables#compile_context
543543
[ref-devtools-playground]: /docs/workspace/playground#editing-the-security-context
544544
[ref-auth-integration]: /access-security/access-control#authentication-integration
545-
[ref-extend-context]: /docs/configuration/reference/config#extend_context
545+
[ref-extend-context]: /reference/configuration/config#extend_context
546546
[ref-dynamic-data-modeling]: /docs/data-modeling/dynamic
547-
[ref-multitenancy]: /docs/configuration/multitenancy
547+
[ref-multitenancy]: /admin/configuration/multitenancy

docs-mintlify/access-security/access-control/data-access-policies.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -566,8 +566,8 @@ cube(`orders`, {
566566

567567
[ref-mls-public]: /access-security/access-control/member-level-security#managing-member-level-access
568568
[ref-sec-ctx]: /access-security/access-control/context
569-
[ref-ref-dap]: /docs/data-modeling/reference/data-access-policies
570-
[ref-ref-dap-role]: /docs/data-modeling/reference/data-access-policies#role
571-
[ref-ref-dap-masking]: /docs/data-modeling/reference/data-access-policies#member-masking
572-
[ref-ref-mask-dim]: /docs/data-modeling/reference/dimensions#mask
573-
[ref-core-data-apis]: /api-reference/core-data-apis
569+
[ref-ref-dap]: /reference/data-modeling/data-access-policies
570+
[ref-ref-dap-role]: /reference/data-modeling/data-access-policies#role
571+
[ref-ref-dap-masking]: /reference/data-modeling/data-access-policies#member-masking
572+
[ref-ref-mask-dim]: /reference/data-modeling/dimensions#mask
573+
[ref-core-data-apis]: /reference/core-data-apis

docs-mintlify/access-security/access-control/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ configuration parameter for details.
3939
[ref-user-attributes]: /access-security/users-and-permissions/user-attributes
4040
[ref-sec-ctx]: /access-security/access-control/context
4141
[ref-dap]: /access-security/access-control/data-access-policies
42-
[ref-query-rewrite]: /docs/configuration/reference/config#query_rewrite
43-
[ref-ctx-to-groups]: /docs/configuration/reference/config#context_to_groups
42+
[ref-query-rewrite]: /reference/configuration/config#query_rewrite
43+
[ref-ctx-to-groups]: /reference/configuration/config#context_to_groups

docs-mintlify/access-security/access-control/member-level-security.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -146,21 +146,21 @@ them entirely, see [data masking][ref-data-masking] in access policies.
146146

147147

148148
[ref-data-modeling-concepts]: /docs/data-modeling/concepts
149-
[ref-apis]: /api-reference
149+
[ref-apis]: /reference
150150
[ref-cubes]: /docs/data-modeling/concepts#cubes
151151
[ref-views]: /docs/data-modeling/concepts#views
152152
[ref-dap]: /access-security/access-control/data-access-policies
153-
[ref-ref-cubes]: /docs/data-modeling/reference/cube
154-
[ref-ref-views]: /docs/data-modeling/reference/view
155-
[ref-dev-mode]: /docs/configuration#development-mode
153+
[ref-ref-cubes]: /reference/data-modeling/cube
154+
[ref-ref-views]: /reference/data-modeling/view
155+
[ref-dev-mode]: /admin/configuration#development-mode
156156
[ref-playground]: /docs/workspace/playground
157-
[ref-dap-ref]: /docs/data-modeling/reference/data-access-policies
158-
[ref-cubes-public]: /docs/data-modeling/reference/cube#public
159-
[ref-views-public]: /docs/data-modeling/reference/view#public
160-
[ref-measures-public]: /docs/data-modeling/reference/measures#public
161-
[ref-dimensions-public]: /docs/data-modeling/reference/dimensions#public
162-
[ref-hierarchies-public]: /docs/data-modeling/reference/hierarchies#public
163-
[ref-segments-public]: /docs/data-modeling/reference/segments#public
157+
[ref-dap-ref]: /reference/data-modeling/data-access-policies
158+
[ref-cubes-public]: /reference/data-modeling/cube#public
159+
[ref-views-public]: /reference/data-modeling/view#public
160+
[ref-measures-public]: /reference/data-modeling/measures#public
161+
[ref-dimensions-public]: /reference/data-modeling/dimensions#public
162+
[ref-hierarchies-public]: /reference/data-modeling/hierarchies#public
163+
[ref-segments-public]: /reference/data-modeling/segments#public
164164
[ref-dynamic-data-modeling]: /docs/data-modeling/dynamic
165165
[ref-security-context]: /access-security/access-control/context
166166
[ref-data-masking]: /access-security/access-control/data-access-policies#data-masking

docs-mintlify/access-security/access-control/row-level-security.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ cube(`orders`, {
6666

6767

6868
[ref-data-modeling-concepts]: /docs/data-modeling/concepts
69-
[ref-apis]: /api-reference
69+
[ref-apis]: /reference
7070
[ref-cubes]: /docs/data-modeling/concepts#cubes
7171
[ref-views]: /docs/data-modeling/concepts#views
72-
[ref-cubes-sql]: /docs/data-modeling/reference/cube#sql
72+
[ref-cubes-sql]: /reference/data-modeling/cube#sql
7373
[ref-dynamic-data-modeling]: /docs/data-modeling/dynamic
7474
[ref-dap]: /access-security/access-control/data-access-policies
7575
[ref-mls]: /access-security/access-control/member-level-security

docs-mintlify/access-security/authentication/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ Regardless of the method, the authentication flow includes the following steps:
2323
and [row-level security][ref-rls] as well as set [access policies][ref-dap].
2424

2525

26-
[ref-apis]: /api-reference
27-
[ref-apis-methods]: /api-reference#authentication-methods
28-
[ref-rest-api]: /api-reference/rest-api
29-
[ref-sql-api]: /api-reference/sql-api
30-
[ref-dax-api]: /api-reference/dax-api
26+
[ref-apis]: /reference
27+
[ref-apis-methods]: /reference#authentication-methods
28+
[ref-rest-api]: /reference/rest-api
29+
[ref-sql-api]: /reference/sql-api
30+
[ref-dax-api]: /reference/dax-api
3131
[ref-cube-cloud-sheets]: /docs/integrations/google-sheets
3232
[ref-name-password]: /access-security/authentication/name-password
3333
[ref-kerberos]: /access-security/authentication/kerberos

docs-mintlify/access-security/authentication/jwt.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ The diagram below shows how it works during the request processing in Cube:
2323

2424
Relevant configuration options: [`check_auth`][ref-config-check-auth] and [`jwt`][ref-config-jwt].
2525

26-
Relevant environment variables: [`CUBEJS_API_SECRET`](/docs/configuration/reference/environment-variables#cubejs_api_secret), [`CUBEJS_JWT_KEY`](/docs/configuration/reference/environment-variables#cubejs_jwt_key), [`CUBEJS_JWK_URL`](/docs/configuration/reference/environment-variables#cubejs_jwk_url),
27-
[`CUBEJS_JWT_AUDIENCE`](/docs/configuration/reference/environment-variables#cubejs_jwt_audience), [`CUBEJS_JWT_ISSUER`](/docs/configuration/reference/environment-variables#cubejs_jwt_issuer), [`CUBEJS_JWT_SUBJECT`](/docs/configuration/reference/environment-variables#cubejs_jwt_subject), [`CUBEJS_JWT_CLAIMS_NAMESPACE`](/docs/configuration/reference/environment-variables#cubejs_jwt_claims_namespace).
26+
Relevant environment variables: [`CUBEJS_API_SECRET`](/reference/configuration/environment-variables#cubejs_api_secret), [`CUBEJS_JWT_KEY`](/reference/configuration/environment-variables#cubejs_jwt_key), [`CUBEJS_JWK_URL`](/reference/configuration/environment-variables#cubejs_jwk_url),
27+
[`CUBEJS_JWT_AUDIENCE`](/reference/configuration/environment-variables#cubejs_jwt_audience), [`CUBEJS_JWT_ISSUER`](/reference/configuration/environment-variables#cubejs_jwt_issuer), [`CUBEJS_JWT_SUBJECT`](/reference/configuration/environment-variables#cubejs_jwt_subject), [`CUBEJS_JWT_CLAIMS_NAMESPACE`](/reference/configuration/environment-variables#cubejs_jwt_claims_namespace).
2828

2929
## Custom authentication
3030

@@ -54,7 +54,7 @@ can still use it to [pass a security context][ref-sec-ctx].
5454

5555
Authentication tokens are generated based on your API secret. Cube CLI generates
5656
an API Secret when a project is scaffolded and saves this value in the `.env`
57-
file as [`CUBEJS_API_SECRET`](/docs/configuration/reference/environment-variables#cubejs_api_secret).
57+
file as [`CUBEJS_API_SECRET`](/reference/configuration/environment-variables#cubejs_api_secret).
5858

5959
You can generate two types of tokens:
6060

@@ -231,8 +231,8 @@ module.exports = {
231231
[link-jwt-docs]: https://github.com/auth0/node-jsonwebtoken#token-expiration-exp-claim
232232
[link-jwt-libs]: https://jwt.io/#libraries-io
233233
[link-jwk-ref]: https://tools.ietf.org/html/rfc7517#section-4
234-
[ref-config-check-auth]: /docs/configuration/reference/config#check_auth
235-
[ref-config-jwt]: /docs/configuration/reference/config#jwt
234+
[ref-config-check-auth]: /reference/configuration/config#check_auth
235+
[ref-config-jwt]: /reference/configuration/config#jwt
236236
[ref-recipe-auth0]: /access-security/access-control/recipes/auth0-guide
237237
[ref-recipe-cognito]: /access-security/access-control/recipes/aws-cognito
238238
[ref-sec-ctx]: /access-security/access-control/context

docs-mintlify/access-security/authentication/kerberos.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ the following environment variables to facilitate the verification of Kerberos t
118118

119119
### Verifying the credentials
120120

121-
By default, [`CUBEJS_SQL_USER`](/docs/configuration/reference/environment-variables#cubejs_sql_user) and [`CUBEJS_SQL_PASSWORD`](/docs/configuration/reference/environment-variables#cubejs_sql_password) environment variables are used
121+
By default, [`CUBEJS_SQL_USER`](/reference/configuration/environment-variables#cubejs_sql_user) and [`CUBEJS_SQL_PASSWORD`](/reference/configuration/environment-variables#cubejs_sql_password) environment variables are used
122122
to verify the passed credentials. You can also customize the authentication by using the
123123
[`check_sql_auth` configuration option][ref-config-check-sql-auth].
124124

@@ -133,7 +133,7 @@ from Power BI][ref-power-bi] to the DAX API.
133133
[link-setspn]: https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/cc731241(v=ws.11)
134134
[link-keytab-file]: https://web.mit.edu/Kerberos/krb5-1.16/doc/basic/keytab_def.html
135135
[link-ktpass]: https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/ktpass
136-
[ref-power-bi]: /docs/configuration/visualization-tools/powerbi#connecting-from-power-bi
136+
[ref-power-bi]: /admin/configuration/visualization-tools/powerbi#connecting-from-power-bi
137137
[link-kerberos]: https://en.wikipedia.org/wiki/Kerberos_(protocol)#Microsoft_Windows
138-
[ref-dax-api]: /api-reference/dax-api
139-
[ref-config-check-sql-auth]: /docs/configuration/reference/config#check_sql_auth
138+
[ref-dax-api]: /reference/dax-api
139+
[ref-config-check-sql-auth]: /reference/configuration/config#check_sql_auth

docs-mintlify/access-security/authentication/name-password.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ to Cube.
1010

1111
## Configuration
1212

13-
By default, [`CUBEJS_SQL_USER`](/docs/configuration/reference/environment-variables#cubejs_sql_user) and [`CUBEJS_SQL_PASSWORD`](/docs/configuration/reference/environment-variables#cubejs_sql_password) environment variables are used
13+
By default, [`CUBEJS_SQL_USER`](/reference/configuration/environment-variables#cubejs_sql_user) and [`CUBEJS_SQL_PASSWORD`](/reference/configuration/environment-variables#cubejs_sql_password) environment variables are used
1414
to verify the credentials. You can also customize the authentication by using the
1515
[`check_sql_auth` configuration option][ref-config-check-sql-auth].
1616

17-
Also, the [`CUBEJS_SQL_SUPER_USER`](/docs/configuration/reference/environment-variables#cubejs_sql_super_user) environment variable or the [`can_switch_sql_user`
17+
Also, the [`CUBEJS_SQL_SUPER_USER`](/reference/configuration/environment-variables#cubejs_sql_super_user) environment variable or the [`can_switch_sql_user`
1818
configuration option][ref-config-can-switch-sql-user] can be used to ensure that the
1919
user name can be changed after the initial authentication.
2020

2121

22-
[ref-config-check-sql-auth]: /docs/configuration/reference/config#check_sql_auth
23-
[ref-config-can-switch-sql-user]: /docs/configuration/reference/config#can_switch_sql_user
22+
[ref-config-check-sql-auth]: /reference/configuration/config#check_sql_auth
23+
[ref-config-can-switch-sql-user]: /reference/configuration/config#can_switch_sql_user

docs-mintlify/access-security/authentication/ntlm.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,19 +88,19 @@ the gateway needs minimal permissions but must exist in that same directory.
8888

8989
### Verifying the credentials
9090

91-
By default, [`CUBEJS_SQL_USER`](/docs/configuration/reference/environment-variables#cubejs_sql_user) and [`CUBEJS_SQL_PASSWORD`](/docs/configuration/reference/environment-variables#cubejs_sql_password) environment variables are used
91+
By default, [`CUBEJS_SQL_USER`](/reference/configuration/environment-variables#cubejs_sql_user) and [`CUBEJS_SQL_PASSWORD`](/reference/configuration/environment-variables#cubejs_sql_password) environment variables are used
9292
to verify the passed credentials. You can also customize the authentication by using the
9393
[`check_sql_auth` configuration option][ref-config-check-sql-auth].
9494

95-
Also, the [`CUBEJS_SQL_SUPER_USER`](/docs/configuration/reference/environment-variables#cubejs_sql_super_user) environment variable or the [`can_switch_sql_user`
95+
Also, the [`CUBEJS_SQL_SUPER_USER`](/reference/configuration/environment-variables#cubejs_sql_super_user) environment variable or the [`can_switch_sql_user`
9696
configuration option][ref-config-can-switch-sql-user] can be used to ensure that the
9797
user name can be changed to the UPN of the interacting user only if proper credentials
9898
of the master user account were passed.
9999

100100

101101
[link-ntlm]: https://en.wikipedia.org/wiki/NTLM
102-
[ref-dax-api]: /api-reference/dax-api
102+
[ref-dax-api]: /reference/dax-api
103103
[link-power-bi-opdg]: https://learn.microsoft.com/en-us/power-bi/connect-data/service-gateway-onprem
104104
[ref-kerberos]: /access-security/authentication/kerberos
105-
[ref-config-check-sql-auth]: /docs/configuration/reference/config#check_sql_auth
106-
[ref-config-can-switch-sql-user]: /docs/configuration/reference/config#can_switch_sql_user
105+
[ref-config-check-sql-auth]: /reference/configuration/config#check_sql_auth
106+
[ref-config-can-switch-sql-user]: /reference/configuration/config#can_switch_sql_user

0 commit comments

Comments
 (0)