mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-15 01:12:56 +03:00
docs: update title / sidebar capitalization & use infinitive verb form in headings (close #8885)
## Description Close: https://github.com/hasura/graphql-engine/issues/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: https://github.com/hasura/graphql-engine-mono/pull/7365 GitOrigin-RevId: 309156a0e7c945edaab950e347025b9e5e1ea9e7
This commit is contained in:
parent
21900dde2d
commit
6fad57dc3b
@ -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
|
||||
|
@ -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
|
||||
|
@ -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>
|
||||
|
||||
|
@ -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>
|
||||
|
||||
|
@ -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>
|
||||
|
||||
|
@ -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>
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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:
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_label: REST Connectors
|
||||
sidebar_label: REST connectors
|
||||
sidebar_position: 9
|
||||
description: REST connectors for Hasura Actions
|
||||
keywords:
|
||||
|
@ -11,7 +11,7 @@ keywords:
|
||||
slug: types/index
|
||||
---
|
||||
|
||||
# Custom GraphQL types
|
||||
# Custom GraphQL Types
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
{
|
||||
"label": "API Reference",
|
||||
"label": "API reference",
|
||||
"position": 170
|
||||
}
|
||||
|
@ -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
|
||||
---
|
||||
|
||||
|
@ -5,7 +5,7 @@ keywords:
|
||||
- docs
|
||||
- postgres
|
||||
- mutation
|
||||
sidebar_label: Kriti Templating
|
||||
sidebar_label: Kriti templating
|
||||
sidebar_position: 13
|
||||
---
|
||||
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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
|
||||
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_label: RESTified GraphQL Endpoints
|
||||
sidebar_label: RESTified GraphQL endpoints
|
||||
sidebar_position: 6
|
||||
description: Hasura RESTified GraphQL API reference
|
||||
keywords:
|
||||
|
@ -1,4 +1,4 @@
|
||||
{
|
||||
"label": "Schema / Metadata APIs (Deprecated)",
|
||||
"label": "Schema / Metadata APIs (deprecated)",
|
||||
"position": 5
|
||||
}
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -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:
|
||||
|
@ -10,7 +10,7 @@ keywords:
|
||||
- syntax definitions
|
||||
---
|
||||
|
||||
# API Reference: Common syntax definitions
|
||||
# API Reference: Common Syntax Definitions
|
||||
|
||||
## TableName {#tablename}
|
||||
|
||||
|
@ -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.
|
||||
|
@ -13,7 +13,7 @@ toc_max_heading_level: 2
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Authentication using JWT
|
||||
# Authentication Using JWT
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -8,9 +8,10 @@ keywords:
|
||||
- unauthenticated access
|
||||
- public access
|
||||
sidebar_position: 3
|
||||
sidebar_label: Unauthenticated / public access
|
||||
---
|
||||
|
||||
# Unauthenticated / Public access
|
||||
# Unauthenticated / Public Access
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -7,12 +7,12 @@ keywords:
|
||||
- auth
|
||||
- webhook
|
||||
sidebar_position: 1
|
||||
sidebar_label: Using Webhooks
|
||||
sidebar_label: Using webhooks
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Authentication using webhooks
|
||||
# Authentication Using Webhooks
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -6,13 +6,14 @@ keywords:
|
||||
- authorization
|
||||
- access control
|
||||
sidebar_position: 2
|
||||
sidebar_label: Access control basics
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Access control basics
|
||||
# Access Control Basics
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -7,11 +7,12 @@ keywords:
|
||||
- access control
|
||||
- examples
|
||||
sidebar_position: 6
|
||||
sidebar_label: Access control examples
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Access control examples
|
||||
# Access Control Examples
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -11,7 +11,7 @@ sidebar_position: 1
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Authorization / Access control
|
||||
# Authorization / Access Control
|
||||
|
||||
## Overview
|
||||
|
||||
|
@ -6,6 +6,7 @@ keywords:
|
||||
- authorization
|
||||
- multiple roles
|
||||
- inherited roles
|
||||
sidebar_label: Inherited roles
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
@ -14,7 +15,7 @@ import TabItem from '@theme/TabItem';
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
|
||||
|
||||
# Inherited roles
|
||||
# Inherited Roles
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -6,6 +6,7 @@ keywords:
|
||||
- permissions
|
||||
- rules
|
||||
sidebar_position: 5
|
||||
sidebar_label: Configure permission rules
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
@ -13,7 +14,7 @@ import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import TOCInline from '@theme/TOCInline';
|
||||
|
||||
# Configuring permission rules
|
||||
# Configure Permission Rules
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -8,12 +8,13 @@ keywords:
|
||||
- permission
|
||||
- role
|
||||
sidebar_position: 6
|
||||
sidebar_label: Multiple column + row permissions for the same role
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
|
||||
|
||||
# Multiple column + row permissions for the same role
|
||||
# Multiple Column + Row Permissions for the Same Role
|
||||
|
||||
## Use case
|
||||
|
||||
|
@ -9,11 +9,12 @@ keywords:
|
||||
- role
|
||||
- session variable
|
||||
sidebar_position: 3
|
||||
sidebar_label: Roles & session variables
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Roles & Session variables
|
||||
# Roles & Session Variables
|
||||
|
||||
## Roles
|
||||
|
||||
|
@ -15,7 +15,7 @@ import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Apollo Federation support
|
||||
# Apollo Federation Support
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_label: Data Federation Types
|
||||
sidebar_label: Data federation types
|
||||
sidebar_position: 2
|
||||
description: Join data across remote data sources
|
||||
keywords:
|
||||
@ -17,28 +17,33 @@ Hasura GraphQL Engine supports the following remote relationships across your va
|
||||
|
||||
To join data across tables between two different database sources, such as order information stored in a Postgres
|
||||
database, and user information stored in a separate Postgres or say a SQL Server database.
|
||||
[Database to database relationships](/schema/postgres/remote-relationships/remote-source-relationships.mdx)
|
||||
|
||||
See [Database to database relationships](/schema/postgres/remote-relationships/remote-source-relationships.mdx).
|
||||
|
||||
## Database to Remote Schema relationships
|
||||
|
||||
To join data across tables and remote GraphQL APIs. For example, you can join customer data from your tables with
|
||||
account data from Stripe, Spotify, or Auth0 via their GraphQL APIs.
|
||||
[Database to Remote Schema relationships](/schema/postgres/remote-relationships/remote-schema-relationships.mdx)
|
||||
|
||||
See [Database to Remote Schema relationships](/schema/postgres/remote-relationships/remote-schema-relationships.mdx).
|
||||
|
||||
## Remote Schema to database relationships
|
||||
|
||||
To join data from remote GraphQL schemas to database tables. For example connecting account data from Stripe, Spotify or
|
||||
Auth0 GraphQL APIs to customer data in your tables.
|
||||
[Remote Schema to database relationships](/remote-schemas/remote-relationships/remote-schema-db-relationships.mdx):
|
||||
|
||||
## Remote Schema to Remote Schema relationships (a.k.a GraphQL joins
|
||||
See [Remote Schema to database relationships](/remote-schemas/remote-relationships/remote-schema-db-relationships.mdx).
|
||||
|
||||
## Remote Schema to Remote Schema relationships (a.k.a GraphQL joins)
|
||||
|
||||
To join data between two remote GraphQL schemas. For example connecting customer data from your custom GraphQL API to
|
||||
account data from Stripe, Spotify or Auth0 GraphQL APIs.
|
||||
[Remote Schema to Remote Schema relationships (a.k.a GraphQL joins)](/remote-schemas/remote-relationships/remote-schema-relationships.mdx)
|
||||
|
||||
See [Remote Schema to Remote Schema relationships (a.k.a GraphQL joins)](/remote-schemas/remote-relationships/remote-schema-relationships.mdx).
|
||||
|
||||
## Action to database relationships
|
||||
|
||||
To join data across tables and Actions (i.e. Rest APIs). For example, you can join user data from your database with
|
||||
the response from a `createUser` action.
|
||||
[Action to database relationships](/schema/postgres/remote-relationships/action-relationships.mdx)
|
||||
|
||||
See [Action to database relationships](/schema/postgres/remote-relationships/action-relationships.mdx).
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: index
|
||||
description: Getting Started with Amazon Athena
|
||||
description: Get started with Amazon Athena
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -9,7 +9,7 @@ keywords:
|
||||
- amazon athena
|
||||
---
|
||||
|
||||
# Getting Started with Amazon Athena
|
||||
# Get Started with Amazon Athena
|
||||
|
||||
:::caution Athena Beta Availability
|
||||
|
||||
|
@ -65,4 +65,4 @@ discord!
|
||||
|
||||
## Know more
|
||||
|
||||
- [Getting Started](/databases/athena/getting-started/index.mdx)
|
||||
- [Get started](/databases/athena/getting-started/index.mdx)
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Hasura Cloud
|
||||
sidebar_position: 1
|
||||
description: Getting Started with Hasura & BigQuery using Hasura Cloud
|
||||
description: Get started with Hasura & BigQuery using Hasura Cloud
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,7 +11,7 @@ keywords:
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Getting started with BigQuery with Hasura Cloud
|
||||
# Get Started with with Hasura Cloud & BigQuery
|
||||
|
||||
Navigate to
|
||||
[cloud.hasura.io](https://cloud.hasura.io/signup/?pg=docs&plcmt=body&cta=navigate-to-cloud-hasura-io&tech=default), and
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Docker
|
||||
sidebar_position: 1
|
||||
description: Getting Started with Hasura & BigQuery using Docker
|
||||
description: Get started with Hasura & BigQuery using Docker
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -11,7 +11,7 @@ keywords:
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Getting started with BigQuery with Hasura in Docker
|
||||
# Get Started with Docker (Hasura and BigQuery)
|
||||
|
||||
Get the Hasura docker-compose file:
|
||||
|
||||
|
@ -1,8 +1,8 @@
|
||||
---
|
||||
slug: index
|
||||
sidebar_label: Getting started
|
||||
sidebar_label: Get started
|
||||
sidebar_position: 1
|
||||
description: Getting Started with Hasura & BigQuery
|
||||
description: Get started with Hasura & BigQuery
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -10,7 +10,7 @@ keywords:
|
||||
- bigquery
|
||||
---
|
||||
|
||||
# Getting started with BigQuery
|
||||
# Get Started with BigQuery
|
||||
|
||||
To try Hasura with BigQuery, you'll need your own new or existing BigQuery database.
|
||||
|
||||
|
@ -28,7 +28,7 @@ To try Hasura with BigQuery, you'll need your own new or existing BigQuery datab
|
||||
|
||||
Here is how you can get started with Hasura and BigQuery:
|
||||
|
||||
[Getting Started with BigQuery](/databases/bigquery/getting-started/index.mdx)
|
||||
[Get started with BigQuery](/databases/bigquery/getting-started/index.mdx)
|
||||
|
||||
<!--
|
||||
|
||||
@ -52,7 +52,7 @@ If you'd like to stay informed about the status of BigQuery support, subscribe t
|
||||
|
||||
## Know more
|
||||
|
||||
- [Getting Started](/databases/bigquery/getting-started/index.mdx)
|
||||
- [Get started](/databases/bigquery/getting-started/index.mdx)
|
||||
- [Schema](/schema/bigquery/index.mdx)
|
||||
|
||||
<!--
|
||||
|
@ -18,6 +18,8 @@ import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Elastic Connection Pools
|
||||
|
||||
<div className="badge badge--primary heading-badge">Available on: Cloud</div>
|
||||
|
||||
## Introduction
|
||||
@ -36,7 +38,7 @@ In Hasura Cloud, the connection pool is elastic i.e. shrinks and grows based on
|
||||
limit. There are many other tunable parameters for the pool settings which can help you change the behaviour of the pool
|
||||
as required. Read more about these in the [How connection pooling works](#how-connection-pooling-works) section below.
|
||||
|
||||
### Getting started
|
||||
### Get started
|
||||
|
||||
Connection pooling is always turned on and the size of the pool can be specified via the `total_max_connections`
|
||||
setting. It is always recommended to set an appropriate `total_max_connections` pool setting based on your workload and
|
||||
|
@ -32,7 +32,7 @@ import Supabase from '@site/static/img/cloud-dbs/logos/supabase.png';
|
||||
import Timescale from '@site/static/img/cloud-dbs/logos/timescaledb.png';
|
||||
import Yugabyte from '@site/static/img/cloud-dbs/logos/yugabyte.png';
|
||||
|
||||
# Guides for connecting Hasura with different cloud databases
|
||||
# Guides for Connecting Hasura with Different Cloud Databases
|
||||
|
||||
## Overview
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_label: Connecting databases
|
||||
sidebar_label: Connect databases
|
||||
sidebar_position: 1
|
||||
description: Connect a database to Hasura
|
||||
keywords:
|
||||
@ -14,7 +14,7 @@ import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Connecting databases to Hasura GraphQL Engine
|
||||
# Connect Databases to Hasura GraphQL Engine
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -19,7 +19,7 @@ import TabItem from '@theme/TabItem';
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
import HeadingIcon from '@site/src/components/HeadingIcon';
|
||||
|
||||
# Read replicas
|
||||
# Read Replicas
|
||||
|
||||
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: index
|
||||
description: Getting Started with Hasura & MS SQL Server
|
||||
description: Get started with Hasura & MS SQL Server
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -9,7 +9,7 @@ keywords:
|
||||
- sql server
|
||||
---
|
||||
|
||||
# Getting started with MS SQL Server
|
||||
# Get Started with MS SQL Server
|
||||
|
||||
To try Hasura with SQL Server, you'll need your own new or existing SQL Server database.
|
||||
|
||||
|
@ -64,7 +64,7 @@ We also have a tutorial available on our Learn site -
|
||||
|
||||
## Know more
|
||||
|
||||
- [Getting Started](/databases/ms-sql-server/getting-started/index.mdx)
|
||||
- [Get Started](/databases/ms-sql-server/getting-started/index.mdx)
|
||||
- [Schema](/schema/ms-sql-server/index.mdx)
|
||||
- [Queries](/queries/ms-sql-server/index.mdx)
|
||||
- [Mutations](/mutations/ms-sql-server/index.mdx)
|
||||
|
@ -10,7 +10,7 @@ sidebar_label: MySQL preview
|
||||
|
||||
import Paperform from '@site/src/components/Paperform';
|
||||
|
||||
# MySQL preview
|
||||
# MySQL Preview
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -24,7 +24,7 @@ If you're currently running Hasura in production with MySQL, please [reach out t
|
||||
|
||||
## Resources
|
||||
|
||||
- [Check out our Getting Started guide for MySQL](/databases/mysql/getting-started.mdx).
|
||||
- [Check out our get started guide for MySQL](/databases/mysql/getting-started.mdx).
|
||||
|
||||
- If you're interested in learning more about MySQL, check out
|
||||
[this tutorial](https://hasura.io/learn/database/mysql/introduction/) from our Learn site.
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
description: Getting Started with Hasura & Citus - Hyperscale
|
||||
description: Get started with Hasura & Citus - Hyperscale
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -8,7 +8,7 @@ keywords:
|
||||
slug: index
|
||||
---
|
||||
|
||||
# Getting started with Citus - Hyperscale
|
||||
# Get Started with Citus - Hyperscale
|
||||
|
||||
To try Hasura with Citus, you'll need your own new or existing Citus database.
|
||||
|
||||
|
@ -10,7 +10,7 @@ keywords:
|
||||
- compatibility
|
||||
---
|
||||
|
||||
# Hasura - Citus compatibility
|
||||
# Hasura - Citus Compatibility
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -24,7 +24,7 @@ Hence with Hasura, Citus also becomes a great fit for cross database joins.
|
||||
|
||||
## Know more
|
||||
|
||||
- [Getting started](/databases/postgres/citus-hyperscale-postgres/getting-started/index.mdx)
|
||||
- [Get started](/databases/postgres/citus-hyperscale-postgres/getting-started/index.mdx)
|
||||
|
||||
- [Hasura - Citus compatibility](/databases/postgres/citus-hyperscale-postgres/hasura-citus-compatibility.mdx)
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
description: Getting Started with Hasura & CockroachDB
|
||||
description: Get started with Hasura & CockroachDB
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -8,7 +8,7 @@ keywords:
|
||||
slug: index
|
||||
---
|
||||
|
||||
# Getting Started with CockroachDB
|
||||
# Get Started with CockroachDB
|
||||
|
||||
To try Hasura with CockroachDB, you'll need your own new or existing CockroachDB database.
|
||||
|
||||
|
@ -29,5 +29,5 @@ https://hasurahq.atlassian.net/browse/NDAT-192
|
||||
|
||||
## Know more
|
||||
|
||||
- [Getting started](/databases/postgres/cockroachdb/getting-started/index.mdx)
|
||||
- [Get started](/databases/postgres/cockroachdb/getting-started/index.mdx)
|
||||
- [Hasura - CockroachDB compatibility](/databases/postgres/cockroachdb/hasura-cockroachdb-compatibility.mdx)
|
||||
|
@ -12,7 +12,7 @@ keywords:
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Get Started with Hasura Cloud and Snowflake
|
||||
# Get Started with Hasura Cloud & Snowflake
|
||||
|
||||
## Try it out
|
||||
|
||||
|
@ -12,7 +12,7 @@ keywords:
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Get Started with Docker and Snowflake
|
||||
# Get Started with Docker (Hasura & Snowflake)
|
||||
|
||||
Testing is currently underway on the Snowflake connector for use in self-hosted environments. Our suggested
|
||||
installation method is to use Docker Compose to deploy a working deployment of Hasura with the Snowflake Connector
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
slug: index
|
||||
description: Getting Started with Snowflake
|
||||
description: Get started with Snowflake
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -8,7 +8,7 @@ keywords:
|
||||
- Snowflake
|
||||
---
|
||||
|
||||
# Getting Started with Snowflake
|
||||
# Get Started with Snowflake
|
||||
|
||||
:::caution Snowflake Beta Availability
|
||||
|
||||
|
@ -63,4 +63,4 @@ discord!
|
||||
|
||||
## Know more
|
||||
|
||||
- [Getting Started](/databases/snowflake/getting-started/index.mdx)
|
||||
- [Get started](/databases/snowflake/getting-started/index.mdx)
|
||||
|
@ -6,6 +6,7 @@ keywords:
|
||||
- deployment
|
||||
- http compression
|
||||
sidebar_position: 70
|
||||
sidebar_label: HTTP compression
|
||||
---
|
||||
|
||||
# HTTP Compression
|
||||
|
@ -14,7 +14,7 @@ import LatestRelease from '@site/src/components/LatestRelease';
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
# Run Hasura GraphQL Engine using Docker
|
||||
# Run Hasura GraphQL Engine Using Docker
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -6,9 +6,10 @@ keywords:
|
||||
- deployment
|
||||
slug: index
|
||||
sidebar_position: 1
|
||||
sidebar_label: Deployment guides
|
||||
---
|
||||
|
||||
# Deployment guides
|
||||
# Deployment Guides
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -7,10 +7,10 @@ keywords:
|
||||
- downgrade
|
||||
- version
|
||||
sidebar_position: 120
|
||||
sidebar_label: Downgrading GraphQL Engine
|
||||
sidebar_label: Downgrade GraphQL Engine
|
||||
---
|
||||
|
||||
# Downgrading Hasura GraphQL Engine
|
||||
# Downgrade Hasura GraphQL Engine
|
||||
|
||||
## Step 1: Update Hasura GraphQL Engine image version
|
||||
|
||||
|
@ -12,7 +12,7 @@ sidebar_position: 3
|
||||
sidebar_label: Server config examples
|
||||
---
|
||||
|
||||
# Server config examples
|
||||
# Server Config Examples
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -12,7 +12,7 @@ slug: index
|
||||
sidebar_label: Server configuration
|
||||
---
|
||||
|
||||
# GraphQL Engine server configuration
|
||||
# GraphQL Engine Server Configuration
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -13,7 +13,7 @@ sidebar_position: 2
|
||||
sidebar_label: Server config reference
|
||||
---
|
||||
|
||||
# GraphQL Engine server config reference
|
||||
# GraphQL Engine Server Config Reference
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -5,7 +5,7 @@ keywords:
|
||||
- disaster
|
||||
- recovery
|
||||
- SLA
|
||||
sidebar_label: Disaster Recovery
|
||||
sidebar_label: Disaster recovery
|
||||
sidebar_position: 50
|
||||
sidebar_class_name: cloud-icon
|
||||
---
|
||||
|
@ -10,7 +10,7 @@ sidebar_position: 60
|
||||
sidebar_label: Server logs
|
||||
---
|
||||
|
||||
# Hasura GraphQL Engine logs
|
||||
# Hasura GraphQL Engine Logs
|
||||
|
||||
## Accessing logs
|
||||
|
||||
|
@ -8,11 +8,12 @@ keywords:
|
||||
- postgres permissions
|
||||
- postgres version
|
||||
sidebar_position: 60
|
||||
sidebar_label: Postgres requirements
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Postgres requirements
|
||||
# Postgres Requirements
|
||||
|
||||
## Supported Postgres versions {#postgres-version-support}
|
||||
|
||||
|
@ -7,12 +7,13 @@ keywords:
|
||||
- production
|
||||
- checklist
|
||||
sidebar_position: 100
|
||||
sidebar_label: Production checklist
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
import TOCInline from '@theme/TOCInline';
|
||||
|
||||
# Production checklist
|
||||
# Production Checklist
|
||||
|
||||
## Introduction
|
||||
|
||||
|
@ -6,10 +6,10 @@ keywords:
|
||||
- deployment
|
||||
- secure
|
||||
sidebar_position: 50
|
||||
sidebar_label: Securing the GraphQL endpoint
|
||||
sidebar_label: Secure the GraphQL endpoint
|
||||
---
|
||||
|
||||
# Securing the GraphQL endpoint
|
||||
# Secure the GraphQL Endpoint
|
||||
|
||||
To make sure that your GraphQL endpoint and the Hasura Console are not publicly accessible, you need to configure an
|
||||
admin secret key.
|
||||
|
@ -7,12 +7,12 @@ keywords:
|
||||
- update
|
||||
- version
|
||||
sidebar_position: 110
|
||||
sidebar_label: Updating GraphQL Engine
|
||||
sidebar_label: Update GraphQL Engine
|
||||
---
|
||||
|
||||
import LatestRelease from '@site/src/components/LatestRelease';
|
||||
|
||||
# Updating Hasura GraphQL Engine
|
||||
# Update Hasura GraphQL Engine
|
||||
|
||||
## Update guides
|
||||
|
||||
@ -22,9 +22,9 @@ simple as changing the image tag.
|
||||
Based on your deployment method, follow the appropriate guide to update
|
||||
the GraphQL Engine version you're running:
|
||||
|
||||
- [Updating on Docker](/deployment/deployment-guides/docker.mdx#docker-update)
|
||||
- [Updating on Kubernetes](/deployment/deployment-guides/kubernetes.mdx#kubernetes-update)
|
||||
- [Updating on Digital Ocean](/deployment/deployment-guides/digital-ocean-one-click.mdx#do-updating)
|
||||
- [Update on Docker](/deployment/deployment-guides/docker.mdx#docker-update)
|
||||
- [Update on Kubernetes](/deployment/deployment-guides/kubernetes.mdx#kubernetes-update)
|
||||
- [Update on Digital Ocean](/deployment/deployment-guides/digital-ocean-one-click.mdx#do-updating)
|
||||
|
||||
:::info No-touch Engine Update in Hasura Cloud
|
||||
|
||||
|
@ -1,8 +1,8 @@
|
||||
---
|
||||
sidebar_label: Enable Caching
|
||||
sidebar_label: Enable caching
|
||||
sidebar_position: 5
|
||||
description: Hasura EE Data Plane Caching
|
||||
title: 'EE: Enable GraphQL Caching'
|
||||
description: Hasura EE caching
|
||||
title: 'EE: Enable GraphQL caching'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Getting Started
|
||||
description: Getting started for the Hasura Enterprise Edition
|
||||
title: 'Getting Started'
|
||||
sidebar_label: Get started
|
||||
description: Gett started for the Hasura Enterprise Edition
|
||||
title: 'EE: Get started'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -9,7 +9,7 @@ keywords:
|
||||
slug: index
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
# Get Started
|
||||
|
||||
<div className="badge badge--primary heading-badge">Available on: Enterprise Edition</div>
|
||||
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Quickstart with AWS ECS
|
||||
description: Quickstart with AWS ECS for Hasura Enterprise Edition
|
||||
title: 'Quickstart with AWS ECS'
|
||||
title: 'EE: Quickstart with AWS ECS'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Quickstart with Docker
|
||||
description: Quickstart with Docker for Hasura Enterprise Edition
|
||||
title: 'Quickstart with Docker'
|
||||
title: 'EE: Quickstart with Docker'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Quickstart with Google Cloud Run
|
||||
description: Quickstart with Google Cloud Run for Hasura Enterprise Edition
|
||||
title: 'Quickstart with Google Cloud Run'
|
||||
title: 'EE: Quickstart with Google Cloud Run'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Quickstart with Kubernetes
|
||||
description: Quickstart with Kubernetes for Hasura Enterprise Edition
|
||||
title: 'Quickstart with Kubernetes'
|
||||
title: 'EE: Quickstart with Kubernetes'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Start Using Hasura EE
|
||||
sidebar_label: Start using Hasura EE
|
||||
description: Start using Hasura EE
|
||||
title: 'Start Using Hasura EE'
|
||||
title: 'EE: Start Using Hasura EE'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
@ -15,7 +15,7 @@ sidebar_position: 5
|
||||
|
||||
## Instructions
|
||||
|
||||
After following one of the Hasura EE getting started guides:
|
||||
After following one of the Hasura EE get started guides:
|
||||
|
||||
- Head to `http://localhost:8080/console` to open the Hasura Console.
|
||||
- Log in using the admin secret key that you set.
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Metrics via Prometheus
|
||||
description: Metrics via Prometheus for Hasura Enterprise Edition
|
||||
title: 'Metrics via Prometheus'
|
||||
title: 'EE: Metrics via Prometheus'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
|
@ -1,8 +1,8 @@
|
||||
---
|
||||
sidebar_label: Release Notes
|
||||
sidebar_label: Release notes
|
||||
sidebar_position: 6
|
||||
description: Release Notes for Hasura EE Data Plane
|
||||
title: 'EE: Release Notes'
|
||||
description: Release notes for Hasura EE
|
||||
title: 'EE: Release notes'
|
||||
date: 2022-08-08T16:30:59+05:30
|
||||
keywords:
|
||||
- hasura
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_label: Upgrading from Hasura CE to Hasura Enterprise
|
||||
description: A guide to upgrading from Hasura CE to Hasura Enterprise
|
||||
title: 'Upgrading from Hasura CE to Hasura Enterprise'
|
||||
sidebar_label: Upgrade from Hasura CE to Hasura Enterprise
|
||||
description: A guide to upgrade from Hasura CE to Hasura Enterprise
|
||||
title: 'EE: Upgrade from Hasura CE to Hasura Enterprise'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
|
@ -18,7 +18,7 @@ import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
|
||||
# Auto cleanup of Event Trigger logs
|
||||
# Auto Cleanup of Event Trigger Logs
|
||||
|
||||
<div className="badge badge--primary heading-badge">Available on: Cloud, Enterprise Edition</div>
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Cleaning up event data
|
||||
title: Clean up event data
|
||||
description: Clean up event data of Event Triggers in Hasura
|
||||
keywords:
|
||||
- hasura
|
||||
@ -9,7 +9,7 @@ keywords:
|
||||
- clean up
|
||||
---
|
||||
|
||||
# Cleaning up event data
|
||||
# Clean up Event Data
|
||||
|
||||
## Introduction
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user