docs: update title / sidebar capitalization & use infinitive verb for…

…m in headings (close #8885) ## Description Close: #8885. This PR introduces the following changes: - Capitalize `#1` headings. - Change sidebar labels to only capitalize features. - Add missing 'Cloud & EE:' (example) information to title to show in browser tabs. - Use infinitive verb form in sidebar and `#1` headings to make it consistent with the rest of docs and to save space. - Updated the `data-federation/data-federation-types` page. Question to the reviewer: - `Use infinitive verb form in sidebar and #1 headings`: Should we add this to the wiki? PR-URL: hasura/graphql-engine-mono#7365 GitOrigin-RevId: 309156a0e7c945edaab950e347025b9e5e1ea9e7
hasura · Dec 23, 2022 · 6fad57d · 6fad57d
1 parent 21900dd
commit 6fad57d
Show file tree

Hide file tree

Showing 271 changed files with 422 additions and 388 deletions.
diff --git a/docs/docs/account-management/billing/billing-data-calculation.mdx b/docs/docs/account-management/billing/billing-data-calculation.mdx
@@ -1,7 +1,7 @@
 ---
 description: Hasura Cloud data usage calculation
-title: 'Cloud: Data Usage Calculation'
-sidebar_label: Hasura Cloud Data Usage Calculation
+title: 'Cloud: Data usage calculation'
+sidebar_label: Hasura Cloud data usage calculation
 keywords:
   - hasura
   - docs

diff --git a/docs/docs/account-management/billing/billing-owner.mdx b/docs/docs/account-management/billing/billing-owner.mdx
@@ -1,7 +1,7 @@
 ---
-description: Billing Owner on Hasura Cloud
-title: 'Cloud: Billing Owner'
-sidebar_label: Billing Owner
+description: Billing owner on Hasura Cloud
+title: 'Cloud: Billing owner'
+sidebar_label: Billing owner
 keywords:
   - hasura
   - docs

diff --git a/docs/docs/account-management/billing/credits.mdx b/docs/docs/account-management/billing/credits.mdx
@@ -8,13 +8,13 @@ keywords:
   - coupon
   - credits
 sidebar_position: 3
-sidebar_label: Hasura Cloud Credits
+sidebar_label: Hasura Cloud credits
 ---
 
 import Thumbnail from '@site/src/components/Thumbnail';
 import HeadingIcon from '@site/src/components/HeadingIcon';
 
-# Coupons and credits
+# Coupons and Credits
 
 <div className='badge badge--primary heading-badge'>Available on: Cloud</div>
 

diff --git a/docs/docs/account-management/billing/payment-methods.mdx b/docs/docs/account-management/billing/payment-methods.mdx
@@ -1,7 +1,7 @@
 ---
-description: Manage Payment Methods
+description: Manage payment methods
 title: 'Cloud: Manage payment methods'
-sidebar_label: Manage Payment Methods
+sidebar_label: Manage payment methods
 keywords:
   - hasura
   - docs
@@ -17,7 +17,7 @@ sidebar_position: 2
 import Thumbnail from '@site/src/components/Thumbnail';
 import HeadingIcon from '@site/src/components/HeadingIcon';
 
-# Manage payment methods
+# Manage Payment Methods
 
 <div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
 

diff --git a/docs/docs/account-management/email-change.mdx b/docs/docs/account-management/email-change.mdx
@@ -1,7 +1,7 @@
 ---
 sidebar_label: Change email
 title: 'Cloud: Change email address'
-description: Hasura Cloud Email Change
+description: Hasura Cloud email change
 keywords:
   - hasura
   - docs
@@ -13,7 +13,7 @@ sidebar_position: 10
 import Thumbnail from '@site/src/components/Thumbnail';
 import HeadingIcon from '@site/src/components/HeadingIcon';
 
-# Change email address
+# Change Email Address
 
 <div className='badge badge--primary heading-badge'>Available on: Cloud</div>
 

diff --git a/docs/docs/account-management/index.mdx b/docs/docs/account-management/index.mdx
@@ -1,7 +1,7 @@
 ---
 slug: index
 title: 'Cloud: Account management'
-description: Hasura Cloud Account Management
+description: Hasura Cloud account management
 keywords:
   - hasura
   - docs
@@ -13,7 +13,7 @@ sidebar_label: Account management
 
 import HeadingIcon from '@site/src/components/HeadingIcon';
 
-# Account management
+# Account Management
 
 <div className='badge badge--primary heading-badge'>Available on: Cloud</div>
 

diff --git a/docs/docs/actions/action-handlers.mdx b/docs/docs/actions/action-handlers.mdx
@@ -13,7 +13,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import Thumbnail from '@site/src/components/Thumbnail';
 
-# Action handlers
+# Action Handlers
 
 ## Introduction
 

diff --git a/docs/docs/actions/action-permissions.mdx b/docs/docs/actions/action-permissions.mdx
@@ -13,7 +13,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import Thumbnail from '@site/src/components/Thumbnail';
 
-# Actions permissions
+# Actions Permissions
 
 ## Introduction
 

diff --git a/docs/docs/actions/action-relationships.mdx b/docs/docs/actions/action-relationships.mdx
@@ -13,7 +13,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import Thumbnail from '@site/src/components/Thumbnail';
 
-# Actions relationships
+# Actions Relationships
 
 ## Introduction
 

diff --git a/docs/docs/actions/codegen/index.mdx b/docs/docs/actions/codegen/index.mdx
@@ -12,7 +12,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import Thumbnail from '@site/src/components/Thumbnail';
 
-# Actions codegen
+# Actions Codegen
 
 ## Introduction
 

diff --git a/docs/docs/actions/codegen/python-flask.mdx b/docs/docs/actions/codegen/python-flask.mdx
@@ -15,7 +15,7 @@ keywords:
 import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
 import Thumbnail from '@site/src/components/Thumbnail';
 
-# GraphQL API with Python & Flask: JWT authentication
+# GraphQL API with Python & Flask: JWT Authentication
 
 ## Introduction
 

diff --git a/docs/docs/actions/create.mdx b/docs/docs/actions/create.mdx
@@ -1,7 +1,7 @@
 ---
-sidebar_label: Creating Actions
+sidebar_label: Create Actions
 sidebar_position: 1
-description: Creating Hasura Actions
+description: Create Hasura Actions
 keywords:
   - hasura
   - docs
@@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem';
 import Thumbnail from '@site/src/components/Thumbnail';
 import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
 
-# Creating Actions
+# Create Actions
 
 ## Introduction
 

diff --git a/docs/docs/actions/derive.mdx b/docs/docs/actions/derive.mdx
@@ -1,18 +1,19 @@
 ---
 sidebar_position: 6
-description: Deriving Hasura Actions
+description: Derive Hasura Actions
 keywords:
   - hasura
   - docs
   - actions
   - derive
+sidebar_label: Derive Actions
 ---
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import Thumbnail from '@site/src/components/Thumbnail';
 
-# Deriving Actions
+# Derive Actions
 
 ## Introduction
 

diff --git a/docs/docs/actions/logs-clean-up.mdx b/docs/docs/actions/logs-clean-up.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: async Action logs clean up
+sidebar_label: Async Action logs clean up
 sidebar_position: 11
 description: Clean up async action logs
 keywords:
@@ -10,7 +10,7 @@ keywords:
   - async actions
 ---
 
-# Cleaning up async Action logs
+# Clean up Async Action Logs
 
 ## Introduction
 

diff --git a/docs/docs/actions/open-api.mdx b/docs/docs/actions/open-api.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: OpenAPI Spec Import
+sidebar_label: OpenAPI spec import
 sidebar_position: 4
 description: Import an Action from an OpenAPI spec
 keywords:

diff --git a/docs/docs/actions/rest-connectors.mdx b/docs/docs/actions/rest-connectors.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: REST Connectors
+sidebar_label: REST connectors
 sidebar_position: 9
 description: REST connectors for Hasura Actions
 keywords:

diff --git a/docs/docs/actions/types.mdx b/docs/docs/actions/types.mdx
@@ -11,7 +11,7 @@ keywords:
 slug: types/index
 ---
 
-# Custom GraphQL types
+# Custom GraphQL Types
 
 ## Introduction
 

diff --git a/docs/docs/api-reference/_category_.json b/docs/docs/api-reference/_category_.json
@@ -1,4 +1,4 @@
 {
-  "label": "API Reference",
+  "label": "API reference",
   "position": 170
 }
diff --git a/docs/docs/api-reference/cloud-api-reference.mdx b/docs/docs/api-reference/cloud-api-reference.mdx
@@ -7,7 +7,7 @@ keywords:
   - API
   - API reference
 sidebar_position: 14
-sidebar_label: Hasura Cloud API Reference
+sidebar_label: Hasura Cloud API reference
 sidebar_class_name: cloud-icon
 ---
 

diff --git a/docs/docs/api-reference/kriti-templating.mdx b/docs/docs/api-reference/kriti-templating.mdx
@@ -5,7 +5,7 @@ keywords:
   - docs
   - postgres
   - mutation
-sidebar_label: Kriti Templating
+sidebar_label: Kriti templating
 sidebar_position: 13
 ---
 

diff --git a/docs/docs/api-reference/metadata-api/computed-field.mdx b/docs/docs/api-reference/metadata-api/computed-field.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Computed Fields
+sidebar_label: Computed fields
 sidebar_position: 8
 description: Manage computed fields with the Hasura Metadata API
 keywords:

diff --git a/docs/docs/api-reference/metadata-api/custom-functions.mdx b/docs/docs/api-reference/metadata-api/custom-functions.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Custom Functions
+sidebar_label: Custom functions
 sidebar_position: 3
 description: Manage custom functions with the Hasura Metadata API
 keywords:

diff --git a/docs/docs/api-reference/metadata-api/custom-types.mdx b/docs/docs/api-reference/metadata-api/custom-types.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Custom Types
+sidebar_label: Custom types
 sidebar_position: 15
 description: Define custom types with the Hasura Metadata API
 keywords:

diff --git a/docs/docs/api-reference/metadata-api/inherited-roles.mdx b/docs/docs/api-reference/metadata-api/inherited-roles.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Inherited Roles
+sidebar_label: Inherited roles
 sidebar_position: 6
 description: Manage inherited roles with the Hasura Metadata API
 keywords:

diff --git a/docs/docs/api-reference/metadata-api/network.mdx b/docs/docs/api-reference/metadata-api/network.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Network Options
+sidebar_label: Network options
 sidebar_position: 19
 description: Manage network options with the Hasura Metadata API
 keywords:

diff --git a/docs/docs/api-reference/metadata-api/query-collections.mdx b/docs/docs/api-reference/metadata-api/query-collections.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Query Collections
+sidebar_label: Query collections
 sidebar_position: 13
 description: Manage query collections with the Hasura Metadata API
 keywords:
@@ -10,7 +10,7 @@ keywords:
   - query collection
 ---
 
-# Metadata API Reference: Query collections
+# Metadata API Reference: Query Collections
 
 ## Introduction
 

diff --git a/docs/docs/api-reference/metadata-api/remote-relationships.mdx b/docs/docs/api-reference/metadata-api/remote-relationships.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Remote Relationships
+sidebar_label: Remote relationships
 sidebar_position: 12
 description: Manage remote relationships with the Hasura Metadata API
 keywords:

diff --git a/docs/docs/api-reference/metadata-api/remote-schema-permissions.mdx b/docs/docs/api-reference/metadata-api/remote-schema-permissions.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Remote Schema Permissions
+sidebar_label: Remote Schema permissions
 sidebar_position: 7
 description: Manage Remote Schema permissions with the Hasura Metadata API
 keywords:

diff --git a/docs/docs/api-reference/metadata-api/restified-endpoints.mdx b/docs/docs/api-reference/metadata-api/restified-endpoints.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: RESTified GraphQL Endpoints
+sidebar_label: RESTified GraphQL endpoints
 sidebar_position: 14
 description: Manage RESTified endpoints with the Hasura Metadata API
 keywords:

diff --git a/docs/docs/api-reference/restified.mdx b/docs/docs/api-reference/restified.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: RESTified GraphQL Endpoints
+sidebar_label: RESTified GraphQL endpoints
 sidebar_position: 6
 description: Hasura RESTified GraphQL API reference
 keywords:

diff --git a/docs/docs/api-reference/schema-metadata-api/_category_.json b/docs/docs/api-reference/schema-metadata-api/_category_.json
@@ -1,4 +1,4 @@
 {
-  "label": "Schema / Metadata APIs (Deprecated)",
+  "label": "Schema / Metadata APIs (deprecated)",
   "position": 5
 }
diff --git a/docs/docs/api-reference/schema-metadata-api/computed-field.mdx b/docs/docs/api-reference/schema-metadata-api/computed-field.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Computed Fields
+sidebar_label: Computed fields
 sidebar_position: 7
 description: Manage computed fields with the Hasura schema/Metadata API
 keywords:

diff --git a/docs/docs/api-reference/schema-metadata-api/custom-functions.mdx b/docs/docs/api-reference/schema-metadata-api/custom-functions.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Custom Functions
+sidebar_label: Custom functions
 sidebar_position: 3
 description: Manage custom functions with the Hasura schema/Metadata API
 keywords:

diff --git a/docs/docs/api-reference/schema-metadata-api/custom-types.mdx b/docs/docs/api-reference/schema-metadata-api/custom-types.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Custom Types
+sidebar_label: Custom types
 sidebar_position: 14
 description: Define custom types with the Hasura schema/Metadata API
 keywords:

diff --git a/docs/docs/api-reference/schema-metadata-api/query-collections.mdx b/docs/docs/api-reference/schema-metadata-api/query-collections.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Query Collections
+sidebar_label: Query collections
 sidebar_position: 12
 description: Manage query collections with the Hasura schema/Metadata API
 keywords:

diff --git a/docs/docs/api-reference/schema-metadata-api/remote-relationships.mdx b/docs/docs/api-reference/schema-metadata-api/remote-relationships.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Remote Relationships
+sidebar_label: Remote relationships
 sidebar_position: 11
 description: Manage remote relationships with the Hasura schema/Metadata API
 keywords:

diff --git a/docs/docs/api-reference/schema-metadata-api/remote-schema-permissions.mdx b/docs/docs/api-reference/schema-metadata-api/remote-schema-permissions.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: Remote Schema Permissions
+sidebar_label: Remote Schema permissions
 sidebar_position: 6
 description: Manage Remote Schema permissions with the Hasura Metadata API
 keywords:

diff --git a/docs/docs/api-reference/schema-metadata-api/restified-endpoints.mdx b/docs/docs/api-reference/schema-metadata-api/restified-endpoints.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_label: RESTified GraphQL Endpoints
+sidebar_label: RESTified GraphQL endpoints
 sidebar_position: 13
 description: Manage RESTified endpoints with the Hasura schema/Metadata API
 keywords:

diff --git a/docs/docs/api-reference/syntax-defs.mdx b/docs/docs/api-reference/syntax-defs.mdx
@@ -10,7 +10,7 @@ keywords:
   - syntax definitions
 ---
 
-# API Reference: Common syntax definitions
+# API Reference: Common Syntax Definitions
 
 ## TableName {#tablename}
 

diff --git a/docs/docs/auth/authentication/integrations/index.mdx b/docs/docs/auth/authentication/integrations/index.mdx
@@ -13,7 +13,7 @@ sidebar_position: 0
 
 import Thumbnail from '@site/src/components/Thumbnail';
 
-# Integrations with external services
+# Integrations with External Services
 
 Hasura is designed to be modular and a part of whichever stack you choose. Below, you'll find some great resources to
 get up-and-running with different auth service providers.