Skip to content

Commit 619cc55

Browse files
seanparkrossrobertjdominguezsurendran82
authored andcommitted
Updates Docusaurus to 2.1
PR-URL: hasura/graphql-engine-mono#6390 Co-authored-by: Rob Dominguez <[email protected]> Co-authored-by: surendran82 <[email protected]> GitOrigin-RevId: ca59e788e7d16bf74389c00a51db18604350b483
1 parent cdb62ff commit 619cc55

Some content is hidden

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

43 files changed

+15697
-11224
lines changed

docs/.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,11 @@
1818
npm-debug.log*
1919
yarn-debug.log*
2020
yarn-error.log*
21+
22+
.pnp.*
23+
.yarn/*
24+
!.yarn/patches
25+
!.yarn/plugins
26+
!.yarn/releases
27+
!.yarn/sdks
28+
!.yarn/versions

docs/.prettierrc.json

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"arrowParens": "avoid",
3+
"bracketSpacing": true,
4+
"embeddedLanguageFormatting": "auto",
5+
"htmlWhitespaceSensitivity": "css",
6+
"insertPragma": false,
7+
"jsxSingleQuote": false,
8+
"proseWrap": "preserve",
9+
"quoteProps": "as-needed",
10+
"requirePragma": false,
11+
"semi": true,
12+
"singleQuote": true,
13+
"tabWidth": 2,
14+
"trailingComma": "es5",
15+
"useTabs": false,
16+
"vueIndentScriptAndStyle": false,
17+
"printWidth": 120,
18+
"overrides": [
19+
{
20+
"files": "*.graphql",
21+
"options": {
22+
"parser": "graphql"
23+
}
24+
}
25+
]
26+
}

docs/.yarn/releases/yarn-3.2.4.cjs

+801
Large diffs are not rendered by default.

docs/.yarnrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
2+
# yarn lockfile v1
3+
4+
5+
yarn-path ".yarn/releases/yarn-1.22.19.cjs"

docs/.yarnrc.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
nodeLinker: node-modules
2+
3+
yarnPath: .yarn/releases/yarn-3.2.4.cjs

docs/docs/account-management/billing/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ All Hasura Cloud billing related details can be found under the `Billing` tab in
2727

2828
## Details
2929

30-
- [Billing owner](/billing-owner.mdx)
30+
- [Billing owner](/account-management/billing/billing-owner.mdx)
3131
- [Manage payment methods](/account-management/billing/payment-methods.mdx)
3232
- [Coupons and credits](/account-management/billing/credits.mdx)
3333
- [Receipts](/account-management/billing/receipts.mdx)

docs/docs/databases/postgres/cockroachdb/getting-started/docker.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -182,11 +182,11 @@ creating a GraphQL query.
182182

183183
## Keep up to date
184184

185-
Hasura currently supports [queries](./queries/postgres/index.mdx),
186-
[relationships](./schema/postgres/table-relationships/index.mdx), and [mutations](./mutations/postgres/index.mdx) on
185+
Hasura currently supports [queries](/queries/postgres/index.mdx),
186+
[relationships](/schema/postgres/table-relationships/index.mdx), and [mutations](/mutations/postgres/index.mdx) on
187187
CockroachDB.
188188

189-
Please refer to the [Postgres docs](./queries/postgres/index.mdx) on how you can try these features out via the Console
189+
Please refer to the [Postgres docs](/queries/postgres/index.mdx) on how you can try these features out via the Console
190190
or by manipulating metadata in JSON/YAML directly.
191191

192192
If you'd like to stay informed about the status of CockroachDB support, subscribe to our newsletter and join our

docs/docs/enterprise/getting-started/index.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ already have one.
3636
Please refer to the quickstart sections which describe how to install Hasura EE in various container platforms. **Each
3737
of the below guides requires HGE versions `v2.12.0` and above.**
3838

39-
- [Quickstart with Docker](/quickstart-docker.mdx)
40-
- [Quickstart with AWS ECS](/quickstart-aws-ecs.mdx)
41-
- [Quickstart with Kubernetes](/quickstart-kubernetes.mdx)
42-
- [Quickstart with Google Cloud Run](/quickstart-google-cloud-run.mdx)
39+
- [Quickstart with Docker](/enterprise/getting-started/quickstart-docker.mdx)
40+
- [Quickstart with AWS ECS](/enterprise/getting-started/quickstart-aws-ecs.mdx)
41+
- [Quickstart with Kubernetes](/enterprise/getting-started/quickstart-kubernetes.mdx)
42+
- [Quickstart with Google Cloud Run](/enterprise/getting-started/quickstart-google-cloud-run.mdx)

docs/docs/enterprise/getting-started/quickstart-docker.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ graphql-engine:
111111
### Step 5: Start using Hasura
112112

113113
Congratulations! You have successfully set up Hasura EE on Docker.
114-
[Start using Hasura EE now](/start-using-hasura-ee.mdx).
114+
[Start using Hasura EE now](/enterprise/getting-started/start-using-hasura-ee.mdx).
115115

116116
## Hasura GraphQL engine server logs {#docker-logs}
117117

docs/docs/enterprise/getting-started/quickstart-kubernetes.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Head to: `http://localhost` and the console should load!
117117
### Step 5: Start using Hasura
118118

119119
Congratulations! You have successfully set up Hasura EE on Docker.
120-
[Start using Hasura EE now](/start-using-hasura-ee.mdx).
120+
[Start using Hasura EE now](/enterprise/getting-started/start-using-hasura-ee.mdx).
121121

122122
## Hasura GraphQL engine server logs {#kubernetes-logs}
123123

docs/docs/migrations-metadata-seeds/manage-migrations.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Edit the file and add your migration actions. For the file format and instructio
8585
to [migration file format](#migrations-file-format).
8686

8787
The corresponding Hasura metadata changes, if any, can be made directly in the appropriate metadata file in the
88-
/metadata directory, refer to [metadata format](/metadata-format.mdx).
88+
/metadata directory, refer to [metadata format](/migrations-metadata-seeds/manage-migrations.mdx).
8989

9090
Apply the metadata and migrations:
9191

docs/docs/schema/bigquery/data-validations.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,8 @@ authors (id int, name text)
142142
articles (id int, title text, author_id int, body text)
143143
```
144144

145-
Also, suppose there is an [object relationship](/table-relationships/index.mdx) `articles.author` defined as:
145+
Also, suppose there is an [object relationship](schema/bigquery/table-relationships/index.mdx) `articles.author`
146+
defined as:
146147

147148
```sql
148149
articles.author_id -> authors.id

docs/docs/schema/common-patterns/index.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ slug: index
1212
A number of common patterns exist across databases. The guides below will help you better understand best practices when
1313
designing and working with GraphQL.
1414

15-
- [Data modeling guides](/data-modeling/index.mdx)
16-
- [Exporting the Hasura GraphQL Schema](/export-graphql-schema.mdx)
15+
- [Data modeling guides](/schema/common-patterns/data-modeling/index.mdx)
16+
- [Exporting the Hasura GraphQL Schema](/schema/common-patterns/export-graphql-schema.mdx)

docs/docs/schema/postgres/postgres-guides/index.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ The following are benefits of Postgres compared to other database management sys
3636

3737
The following are some Postgres features that can be used to manage your data and extend your Hasura GraphQL API:
3838

39-
- [Constraints](/constraints.mdx)
40-
- [Views](/views.mdx)
41-
- [Functions](/functions.mdx)
42-
- [Triggers](/triggers.mdx)
43-
- [Indexes](/indexes.mdx)
44-
- [Import data from CSV](/import-data-from-csv.mdx)
45-
- [Auditing tables](/auditing-tables.mdx)
39+
- [Constraints](/schema/postgres/postgres-guides/constraints.mdx)
40+
- [Views](/schema/postgres/postgres-guides/views.mdx)
41+
- [Functions](/schema/postgres/postgres-guides/functions.mdx)
42+
- [Triggers](/schema/postgres/postgres-guides/triggers.mdx)
43+
- [Indexes](/schema/postgres/postgres-guides/indexes.mdx)
44+
- [Import data from CSV](/schema/postgres/postgres-guides/import-data-from-csv.mdx)
45+
- [Auditing tables](/schema/postgres/postgres-guides/auditing-tables.mdx)

docs/docs/schema/postgres/postgres-guides/views.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ REFRESH MATERIALIZED VIEW popular_active_authors;
9898
```
9999

100100
Materialized views can be refreshed when their underlying source data changes using
101-
[Postgres triggers](/triggers.mdx).
101+
[Postgres triggers](/schema/postgres/postgres-guides/triggers.mdx).
102102

103103
## Postgres views & Hasura
104104

docs/docusaurus.config.js

+6-2
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,12 @@ const config = {
9191
themeConfig:
9292
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
9393
({
94-
hideableSidebar: true,
95-
autoCollapseSidebarCategories: true,
94+
docs: {
95+
sidebar: {
96+
hideable: true,
97+
autoCollapseCategories: true
98+
}
99+
},
96100
colorMode: {
97101
defaultMode: 'light',
98102
disableSwitch: false,

docs/package.json

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
{
22
"name": "docs",
3+
"description": "Hasura GraphQL Engine Documentation",
34
"version": "0.0.0",
45
"private": true,
6+
"engines": {
7+
"node": ">=16.14"
8+
},
59
"scripts": {
610
"docusaurus": "docusaurus",
711
"start": "docusaurus start",
@@ -17,25 +21,26 @@
1721
"typecheck": "tsc"
1822
},
1923
"dependencies": {
20-
"@docusaurus/core": "^2.0.0-beta.18",
21-
"@docusaurus/preset-classic": "^2.0.0-beta.18",
24+
"@docusaurus/core": "^2.1.0",
25+
"@docusaurus/preset-classic": "^2.1.0",
2226
"@mdx-js/react": "^1.6.21",
2327
"algoliasearch": "^4.14.2",
2428
"algoliasearch-helper": "^3.7.4",
25-
"clsx": "^1.1.1",
29+
"clsx": "^1.2.1",
2630
"docusaurus-plugin-sass": "^0.2.2",
2731
"graphiql": "^1.5.1",
2832
"graphql": "^15.7.2",
29-
"prism-react-renderer": "^1.2.1",
33+
"prism-react-renderer": "^1.3.5",
3034
"react": "^17.0.2",
3135
"react-dom": "^17.0.2",
3236
"react-transition-group": "^4.4.2",
3337
"sass": "^1.49.8"
3438
},
3539
"devDependencies": {
36-
"@docusaurus/module-type-aliases": "^2.0.0-beta.18",
37-
"@tsconfig/docusaurus": "^1.0.4",
38-
"typescript": "^4.5.5"
40+
"@docusaurus/module-type-aliases": "^2.1.0",
41+
"@tsconfig/docusaurus": "^1.0.6",
42+
"prettier": "^2.7.1",
43+
"typescript": "^4.8.4"
3944
},
4045
"browserslist": {
4146
"production": [
@@ -48,5 +53,6 @@
4853
"last 1 firefox version",
4954
"last 1 safari version"
5055
]
51-
}
56+
},
57+
"packageManager": "[email protected]"
5258
}

0 commit comments

Comments
 (0)