partial submission for docs:capitalization of headings #8885

GITHUB_PR_NUMBER: 9072
GITHUB_PR_URL: https://github.com/hasura/graphql-engine/pull/9072

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/6201
Co-authored-by: Phuong-Cat Ngo <44314126+catcecilia@users.noreply.github.com>
GitOrigin-RevId: 96fa8807ded210e3d384cb7d4181088804c01fb6
This commit is contained in:
hasura-bot 2022-10-28 23:11:38 +05:30
parent ae9d1308e6
commit 659b340ffa
56 changed files with 81 additions and 81 deletions

View File

@ -16,12 +16,12 @@ slug: glossary/index
Docker is a system which allows the packaging up of code and all its dependencies so the an application runs
quickly and reliably from one computing environment to another.
## Docker Container
## Docker container
A Docker container image is a lightweight, standalone, executable package of software that includes everything
needed to run an application: code, runtime, system tools, system libraries and settings. Hasura can be run as a
Docker container.
## Docker Image
## Docker image
Docker images become containers at runtime and in the case of Docker containers images become containers
when they run on Docker Engine which is available for both Linux and Windows-based applications, containerized
software will always run the same, regardless of the infrastructure. Containers isolate software from its
@ -29,7 +29,7 @@ environment and ensure that it works uniformly despite differences for instance
Hasura is distributed as a Docker image for the Community Edition at
[DockerHub](https://hub.docker.com/r/hasura/graphql-engine).
## GraphQL Schema
## GraphQL schema
Every GraphQL service defines a set of types which completely describe the set of possible data you can query on
that service. This is called the GraphQL schema. Hasura automatically generates a GraphQL Schema for you from the
tables in your connected databases, Hasura Actions you've defined, and other connected GraphQL or REST endpoints.
@ -50,10 +50,10 @@ configured Hasura endpoint in order to change or "mutate" data on your database,
The container(s) serving the GraphQL API and in the critical path of every request/response.
## Hasura Account
## Hasura account
An account on [hasura.io](https://hasura.io) in which multiple cloud instances of Hasura Cloud can be created.
## Hasura GraphQL Engine
## Hasura GraphQL engine
The Docker container(s) serving the GraphQL API and in the critical path of every request/response.

View File

@ -11,7 +11,7 @@ keywords:
sidebar_position: 3
---
# Cleaning up scheduled triggers data
# Cleaning Up Scheduled Triggers Data
## Introduction

View File

@ -13,7 +13,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Creating a cron trigger
# Creating a Cron Trigger
## Introduction
@ -192,4 +192,4 @@ REST Connectors modify the cron trigger's HTTP request to adapt to your webhook'
transforms.
Currently, rest connectors for cron triggers can only be configured through the CLI and the
[metadata API](/api-reference/metadata-api/scheduled-triggers.mdx#metadata-create-cron-trigger).
[metadata API](/api-reference/metadata-api/scheduled-triggers.mdx#metadata-create-cron-trigger).

View File

@ -13,7 +13,7 @@ keywords:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# BigQuery: Computed fields
# BigQuery: Computed Fields
## What are computed fields?

View File

@ -14,7 +14,7 @@ keywords:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# BigQuery: Customise auto-generated field names
# BigQuery: Customise Auto-Generated Field Names
## Introduction

View File

@ -15,7 +15,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# BigQuery: Data validations
# BigQuery: Data Validations
## Introduction

View File

@ -10,7 +10,7 @@ keywords:
- remote relationship
---
# BigQuery: Remote relationships
# BigQuery: Remote Relationships
## Introduction

View File

@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# BigQuery: Database to remote schema relationships
# BigQuery: Database to Remote Schema Relationships
## Introduction

View File

@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# BigQuery: Database to remote database relationships
# BigQuery: Database to Remote Database Relationships
## Introduction

View File

@ -16,7 +16,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# BigQuery: Creating relationships
# BigQuery: Creating Relationships
## Introduction

View File

@ -9,7 +9,7 @@ keywords:
slug: index
---
# BigQuery: Relationships between tables/views
# BigQuery: Relationships Between Tables/Views
## Introduction

View File

@ -14,7 +14,7 @@ keywords:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# BigQuery: Renaming relationships
# BigQuery: Renaming Relationships
An existing relationship can be renamed as follows:

View File

@ -15,7 +15,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# BigQuery: Tables basics
# BigQuery: Tables Basics
## Introduction

View File

@ -14,7 +14,7 @@ keywords:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# MS SQL Server: Customise auto-generated field names
# MS SQL Server: Customise Auto-Generated Field Names
## Introduction

View File

@ -9,7 +9,7 @@ keywords:
slug: index
---
# MS SQL Server: Setting default values for fields
# MS SQL Server: Setting Default Values for Fields
Let's say you want certain fields to have their values set automatically when not explicitly passed. You can do this in
the following ways:

View File

@ -15,7 +15,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
# MS SQL Server: Setting values for fields using role-based column presets
# MS SQL Server: Setting Values for Fields Using Role-Based Column Presets
## Introduction

View File

@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# MS SQL Server: Setting default values for fields using MS SQL Server defaults
# MS SQL Server: Setting Default Values for Fields Using MS SQL Server Defaults
## Introduction

View File

@ -10,7 +10,7 @@ keywords:
- remote relationship
---
# MS SQL Server: Remote relationships
# MS SQL Server: Remote Relationships
## Introduction

View File

@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# MS SQL Server: Database to Remote Schema relationships
# MS SQL Server: Database to Remote Schema Relationships
## Introduction

View File

@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# MS SQL Server: Database to remote database relationships
# MS SQL Server: Database to Remote Database Relationships
## Introduction

View File

@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# MS SQL Server: Creating relationships
# MS SQL Server: Creating Relationships
## Introduction

View File

@ -9,7 +9,7 @@ keywords:
- database modeling
---
# Database relationship modeling guides
# Database Relationship Modelling Guides
The following guides will help you model the different types of table relationships in the database:

View File

@ -9,7 +9,7 @@ keywords:
- relationship
---
# MS SQL Server: Relationships between tables/views
# MS SQL Server: Relationships Between Tables/Views
## Introduction

View File

@ -14,7 +14,7 @@ keywords:
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
# MS SQL Server: Renaming relationships
# MS SQL Server: Renaming Relationships
An existing relationship can be renamed as follows:

View File

@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# MS SQL Server: Tables basics
# MS SQL Server: Tables Basics
## Introduction

View File

@ -12,7 +12,7 @@ keywords:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Setting up a GraphQL schema using an existing MS SQL Server database
# Setting Up a GraphQL Schema Using an Existing MS SQL Server Database
## Introduction

View File

@ -13,7 +13,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
# MS SQL Server: Extend schema with views
# MS SQL Server: Extend Schema with Views
## What are views?

View File

@ -350,9 +350,9 @@ computed fields are defined via an SQL function, which allows users to define an
Generated columns will go together with computed fields where Hasura treats generated columns as normal Postgres
columns.
## Computed fields in Remote relationships
## Computed fields in Remote Relationships
Using computed fields in [Remote relationships](/schema/postgres/remote-relationships/index.mdx) allows transformation
Using computed fields in [Remote Relationships](/schema/postgres/remote-relationships/index.mdx) allows transformation
of data from table columns before joining with data from remote sources. For instance, suppose we want to extract
certain field from a `json` column and join it with a field in a remote schema by argument value. We would define a
computed field which returns a scalar type of the field value in the `json` column and use it to join the graphql field

View File

@ -15,7 +15,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
# Postgres: Setting values for fields using role-based column presets
# Postgres: Setting Values for Fields Using Role-Based Column Presets
## Introduction

View File

@ -15,7 +15,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
# Postgres: Adding created_at / updated_at timestamps
# Postgres: Adding created_at / updated_at Timestamps
## Introduction

View File

@ -9,7 +9,7 @@ keywords:
- default value
---
# Postgres: Setting default values for fields
# Postgres: Setting Default Values for Fields
Let's say you want certain fields to have their values set automatically when not explicitly passed. You can do this in
the following ways:

View File

@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# Postgres: Setting default values for fields using Postgres defaults
# Postgres: Setting Default Values for Fields Using Postgres Defaults
## Introduction

View File

@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# Postgres: Setting values of fields using SQL functions
# Postgres: Setting Values of Fields Using SQL Functions
## Introduction

View File

@ -312,7 +312,7 @@ variables:
}
```
## Implicitly Supported types {#implicit}
## Implicitly supported types {#implicit}
All `Implicit` types in the [above table](#types-table) are implicitly
supported by the GraphQL engine. You have to provide the value as a

View File

@ -12,7 +12,7 @@ keywords:
import Thumbnail from '@site/src/components/Thumbnail';
# Postgres: Relay schema
# Postgres: Relay Schema
## Introduction

View File

@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# Postgres: Action to database relationships
# Postgres: Action to Database Relationships
## Introduction

View File

@ -10,7 +10,7 @@ keywords:
- remote relationship
---
# Postgres: Remote relationships
# Postgres: Remote Relationships
## Introduction

View File

@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# Postgres: Database to Remote Schema relationships
# Postgres: Database to Remote Schema Relationships
## Introduction

View File

@ -16,7 +16,7 @@ import TabItem from '@theme/TabItem';
import Thumbnail from '@site/src/components/Thumbnail';
import GraphiQLIDE from '@site/src/components/GraphiQLIDE';
# Postgres: Database to remote database relationships
# Postgres: Database to Remote Database Relationships
## Introduction

View File

@ -16,7 +16,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Postgres: Creating relationships
# Postgres: Creating Relationships
## Introduction

View File

@ -9,7 +9,7 @@ keywords:
- database modeling
---
# Database relationship modeling guides
# Database Relationship Modelling Guides
The following guides will help you model the different types of table relationships in the database:

View File

@ -9,7 +9,7 @@ keywords:
slug: index
---
# Postgres: Relationships between tables/views
# Postgres: Relationships Between Tables/Views
## Introduction

View File

@ -14,7 +14,7 @@ keywords:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Postgres: Renaming relationships
# Postgres: Renaming Relationships
An existing relationship can be renamed as follows:

View File

@ -12,7 +12,7 @@ keywords:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Setting up a GraphQL schema using an existing Postgres database
# Setting Up a GraphQL Schema Using an Existing Postgres Database
## Introduction

View File

@ -13,7 +13,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Postgres: Extend schema with views
# Postgres: Extend Schema with Views
## What are views?

View File

@ -196,11 +196,11 @@ All API limits are **not** applied for the admin role, and depth limits are **NO
:::
## Metadata Specification
## Metadata specification
Hasura provides two metadata API's to manage API limits
### Setting API Limits
### Setting API limits
You can configure api limits using the `set_api_limits` API.
@ -292,7 +292,7 @@ args:
user: 2
```
### Removing API Limits
### Removing API limits
You can remove **all** the api limits that have been set using `remove_api_limit` API.

View File

@ -52,7 +52,7 @@ If both `HASURA_GRAPHQL_ADMIN_SECRET` and `HASURA_GRAPHQL_ADMIN_SECRETS` are set
:::
## Rotating admin secrets (Self-hosted environments)
## Rotating admin secrets (self-hosted environments)
When you have a self-hosted Hasura EE setup, you can use this feature to implement a secret rotation mechanism without
downtime as outlined below:

View File

@ -47,7 +47,7 @@ different from a live query as it sends individual rows at a time and not the en
See more details [here](/subscriptions/postgres/streaming/index.mdx).
### Live query vs Streaming subscriptions
### Live query vs streaming subscriptions
Suppose we need to display the messages of a group chat on a page, this can be done either via live queries or streaming
subscriptions. Let's see how they can be used and how they differ from each other.

View File

@ -263,7 +263,7 @@ update `CHANGELOG.md` in the root directory of the repo as well.
:::
## Common Errors
## Common errors
We all make mistakes! Here's the most common ones we encounter. This is not an exhaustive list, but if you find lots of
errors getting thrown, chances are the issue is one of the items below. These are rank-ordered according to what we

View File

@ -53,7 +53,7 @@ supported language is not listed here, please add it to `additionalLanguages` un
:::
## Parsed Literals
## Parsed literals
Sometimes we want to add links within codeblocks, the triple backtick syntax won't work in this case. Please use
`pre` and `code` tags and use plain html within the `code`. To preserve indentation prefer string templates

View File

@ -30,15 +30,15 @@ Which renders out as:
# This is the Main Page Title
## This is a H2 Heading
## This is a H2 heading
### This is a H3 Heading
### This is a H3 heading
#### This is a H4 Heading
#### This is a H4 heading
##### This is a H5 Heading
##### This is a H5 heading
###### This is a H6 Heading
###### This is a H6 heading
:::info Note
@ -57,7 +57,7 @@ The generated id's are nothing but the `kebab-cased-heading-text-itself`.
Ex:
```markdown
## Heading H2 Example
## Heading H2 example
<!-- will have a generated id as below -->
heading-h2-example
@ -84,7 +84,7 @@ section.
:::
## Handling Custom Ids
## Handling custom ids
Custom Heading Ids are added as `{#kebab-cased-id}`

View File

@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem';
`[Hasura Cloud](https://cloud.hasura.io/signup/)`
## Internal Links
## Internal links
Since MDX doesn't yet support this direct referencing, we have to rely on relative/root relative path resolution for
[referencing other documents](https://docusaurus.io/docs/docs-markdown-features#referencing-other-documents).

View File

@ -116,7 +116,7 @@ Which would render like this
</tbody>
</table>
## With Code Blocks
## With code blocks
When a table cell is just a codeblock, the normal triple tick syntax works fine. But, please do leave an intentional empty line before and after the code block.
Also, start the code block and respective cell (`td/th`) at the very beginning of line (no empty tabs/spaces at start).

View File

@ -19,7 +19,7 @@ Below is auto listed TOC for this document
<TOCInline toc={toc} />
## Full Table of Contents
## Full table of contents
This is the simplest way and is autogenerated on usage of `TOCInline` component from docusaurus.
@ -59,7 +59,7 @@ redundancy as TOC is available on right sidebar.
:::
## Partial (Sub) Table of Contents
## Partial (sub) table of contents
If one individual section requires to have its own TOC. Below is how it can be achieved in docusaurus.
@ -123,11 +123,11 @@ Please check the [Breaking changes that forced us to swizzle](https://docusaurus
## Custom Table of Contents
## Custom table of contents
Custom/Manually generated TOC can be a simple list or a group of lists (like a root index page)
### Simple List
### Simple list
Unfortunately, there is no direct alternative for this in either MDX or Docusaurus.
@ -178,7 +178,7 @@ when using both types of syntax.
will render something like below.
### Group of Lists
### Group of lists
Its a list of simple lists (UI wise).
Unfortunately, there is no direct alternative for this in either MDX or Docusaurus. So we have to list these links

View File

@ -32,12 +32,12 @@ user.
- Make sure if you are cropping a smaller area or component that the user understands where to find it and its place in
context within their workflow.
### File Type
### File type
- Use PNGs.
- PNGs will automatically be optimized when added to the pull request
### File Name
### File name
- Include the Hasura feature and version number in the screenshot name to make it easier to check when screenshots are
outdated.
@ -45,7 +45,7 @@ user.
`{{action-depicted}}_{{image-step-or-variation-number-if-needed}}_{{hasura-feature-depicted}}_{{hasura-feature-version}}.png`
- eg: `connect-database-google-cloud_step-2_console_2-7-1.png`
### Callouts, Arrows and Other Screenshot Markup
### Callouts, arrows and other screenshot markup
- Use hex color <pre style={{ background: `#FC336D` }}>#FC336D</pre> for all image markup.
- Use rounded corners on callout blocks.

View File

@ -27,14 +27,14 @@ All the magic happens here. [SEO](https://docusaurus.io/docs/seo), [Theme](https
Please check the [API for all possible config options here](https://docusaurus.io/docs/api/docusaurus-config).
## Cleint API - Components, Hooks etc.
## Cleint API - components, hooks etc.
Please check the [client API docs](https://docusaurus.io/docs/docusaurus-core) for available React components, hooks &
modules.
## Sidebar
### Label & Position
### Label & position
**For Individual Files**
@ -75,7 +75,7 @@ visible unless there is one more file.
If you only have an index.mdx file, prefer `directory.mdx` over `directory/index.mdx`.
## URL Slug
## URL slug
This only applies for index.mdx files.
@ -98,7 +98,7 @@ element to see the complete list).
These variables can be overridden and new custom styles to be added in `src/css/custom.scss` and
`src/css/_custom-dark.scss` for light and dark themes respectively.
## React Components
## React components
Add any new React Components to the `src/components/ComponentName` directory. Add the `index.tsx` file and use
`styles.module.scss` for styling to not let this collide with global styles.
@ -113,7 +113,7 @@ Check existing components for a better idea.
:::
## Static Assets
## Static assets
All the static assets lives in `static` directory.
@ -123,7 +123,7 @@ All the static assets lives in `static` directory.
| Fonts | `static/fonts` |
| Icons | `static/icons` |
## Updating to latest Docusaurus Version
## Updating to latest Docusaurus version
Checkout the change log for latest releases and changes involved - https://docusaurus.io/changelog/