Skip to content

Commit dc0dc30

Browse files
marionschleiferSamirTalwarlucarestagnohasura-botsoupi
committed
docs: capitalize hasura features
## Description [Jira ticket](https://hasurahq.atlassian.net/jira/software/projects/DOCS/boards/19?selectedIssue=DOCS-102). This PR capitalizes Hasura features based on our [feature capitalization guide on the docs wiki](https://hasura.io/docs/wiki/style/hasura-features/). It also introduces some linting by prettier. PR-URL: hasura/graphql-engine-mono#7260 Co-authored-by: Samir Talwar <[email protected]> Co-authored-by: Luca Restagno <[email protected]> Co-authored-by: hasura-bot <[email protected]> Co-authored-by: Gil Mizrahi <[email protected]> Co-authored-by: Stefano Magni <[email protected]> Co-authored-by: Daniel Harvey <[email protected]> Co-authored-by: Abby Sassel <[email protected]> Co-authored-by: Daniele Cammareri <[email protected]> Co-authored-by: Brandon Martin <[email protected]> GitOrigin-RevId: 5946f313cb44c639fac61e6c7fb44f704ee2a709
1 parent 5aa1385 commit dc0dc30

File tree

357 files changed

+5045
-4977
lines changed

Some content is hidden

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

357 files changed

+5045
-4977
lines changed

docs/.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,6 @@ yarn-error.log*
2525
!.yarn/plugins
2626
!.yarn/releases
2727
!.yarn/sdks
28-
!.yarn/versions
28+
!.yarn/versions
29+
30+
.tool-versions

docs/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Issues also marked as `help wanted` (see
1515
are those that require community contributions.
1616

1717
Please note that some of these issues, labelled with both `c/docs` and `c/console`/`c/server`, are part of a change/task
18-
that requires modifications in some component of GraphQL engine and the docs.
18+
that requires modifications in some component of GraphQL Engine and the docs.
1919

2020
Feel free to open pull requests to address these issues or to add/fix docs features/content, even if a corresponding
2121
issue doesn't exist. If you are unsure about whether to go ahead and work on something like the latter, please get in
22-
touch with the maintainers in the `GraphQL engine`->`contrib` channel in the community
22+
touch with the maintainers in the `GraphQL Engine`->`contrib` channel in the community
2323
[Discord](https://discord.gg/vBPpJkS).
2424

2525
## Notes

docs/docs/account-management/billing/billing-data-calculation.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ the operations that are performed by you, your apps, or your clients.
2626

2727
The data pass-through is calculated by analyzing the logs that are sent from your project. All data transfer from Hasura
2828
Cloud to external networks - such as your database server, external webhooks for [Actions](/actions/index.mdx),
29-
[event triggers](/event-triggers/index.mdx), [scheduled triggers](/scheduled-triggers/index.mdx) or your
29+
[Event Triggers](/event-triggers/index.mdx), [Scheduled Triggers](/scheduled-triggers/index.mdx) or your
3030
[Remote Schema](/remote-schemas/index.mdx) - is accounted for in Hasura Cloud billing.
3131

3232
We account for the following types of logs in Hasura Cloud data pass-through:
@@ -47,7 +47,7 @@ We account for the following types of logs in Hasura Cloud data pass-through:
4747
calculating your data usage. This log is generated when Hasura triggers an external webhook.
4848

4949
- `scheduled-trigger-log`: The sizes of the request and response of the `scheduled-trigger-log` are taken into account
50-
for calculating your data usage. The cost incurred by this depends on the frequency of scheduled triggers.
50+
for calculating your data usage. The cost incurred by this depends on the frequency of Scheduled Triggers.
5151

5252
These logs are used to calculate your data usage in Hasura Cloud, which is then used for generating monthly invoices.
5353
You can find more information about the pricing for data pass-through [on our pricing page](https://hasura.io/pricing/).

docs/docs/actions/action-handlers.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -180,17 +180,17 @@ For your action, add a header that will act as an action secret.
180180
<Tabs groupId="user-preference" className="api-tabs">
181181
<TabItem value="console" label="Console">
182182

183-
Head to the `Actions -> [action-name]` tab in the console and scroll down to `Headers`. You can now configure an action
183+
Head to the `Actions -> [action-name]` tab in the Console and scroll down to `Headers`. You can now configure an action
184184
secret by adding a header:
185185

186-
<Thumbnail src='/img/actions/action-secret-header.png' alt='Console action secret' width='700px' />
186+
<Thumbnail src="/img/actions/action-secret-header.png" alt="Console action secret" width="700px" />
187187

188188
Then hit `Save`.
189189

190190
</TabItem>
191191
<TabItem value="cli" label="CLI">
192192

193-
Go to `metadata/actions.yaml` in the Hasura project directory.
193+
Go to `metadata/actions.yaml` in the Hasura Project directory.
194194

195195
Update the definition of your action by adding the action secret as a header:
196196

@@ -212,7 +212,7 @@ Save the changes and run `hasura metadata apply` to set the headers.
212212
<TabItem value="api" label="API">
213213

214214
Headers can be set when [creating](/api-reference/metadata-api/actions.mdx#metadata-create-action) or
215-
[updating](/api-reference/metadata-api/actions.mdx#metadata-update-action) an action via the metadata API.
215+
[updating](/api-reference/metadata-api/actions.mdx#metadata-update-action) an action via the Metadata API.
216216

217217
```http {12-17}
218218
POST /v1/metadata HTTP/1.1
@@ -251,8 +251,8 @@ X-Hasura-Role: admin
251251
:::info Note
252252

253253
Before creating an action via the
254-
[create_action metadata API](/api-reference/metadata-api/actions.mdx#metadata-create-action), all custom types need to
255-
be defined via the [set_custom_types](/api-reference/metadata-api/custom-types.mdx#metadata-set-custom-types) metadata
254+
[create_action Metadata API](/api-reference/metadata-api/actions.mdx#metadata-create-action), all custom types need to
255+
be defined via the [set_custom_types](/api-reference/metadata-api/custom-types.mdx#metadata-set-custom-types) Metadata
256256
API.
257257

258258
:::

docs/docs/actions/action-permissions.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_label: Actions permissions
33
sidebar_position: 7
4-
description: Permissions for Hasura actions
4+
description: Permissions for Hasura Actions
55
keywords:
66
- hasura
77
- docs
@@ -24,16 +24,16 @@ As with the other fields in the GraphQL schema, users need to be given access to
2424
<Tabs groupId="user-preference" className="api-tabs">
2525
<TabItem value="console" label="Console">
2626

27-
Head to the `Actions -> [action-name] -> Permissions` tab in the console.
27+
Head to the `Actions -> [action-name] -> Permissions` tab in the Console.
2828

29-
<Thumbnail src='/img/actions/actions-permissions.png' alt='Console action permission' />
29+
<Thumbnail src="/img/actions/actions-permissions.png" alt="Console action permission" />
3030

3131
Hit `Save` to give the role permission to access the action.
3232

3333
</TabItem>
3434
<TabItem value="cli" label="CLI">
3535

36-
Go to `metadata/actions.yaml` in the Hasura project directory.
36+
Go to `metadata/actions.yaml` in the Hasura Project directory.
3737

3838
Update the definition of the `insertAuthor` action as:
3939

@@ -54,7 +54,7 @@ Save the changes and run `hasura metadata apply` to set the permissions.
5454
<TabItem value="api" label="API">
5555

5656
Action permissions can be set by using the
57-
[create_action_permission](/api-reference/metadata-api/actions.mdx#metadata-create-action-permission) metadata API:
57+
[create_action_permission](/api-reference/metadata-api/actions.mdx#metadata-create-action-permission) Metadata API:
5858

5959
```http
6060
POST /v1/metadata HTTP/1.1

docs/docs/actions/action-relationships.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_label: Actions relationships
33
sidebar_position: 8
4-
description: Manage Hasura actions relationships
4+
description: Manage Hasura Actions relationships
55
keywords:
66
- hasura
77
- docs
@@ -82,18 +82,18 @@ You can create relationships for custom output types by:
8282
<Tabs groupId="user-preference" className="api-tabs">
8383
<TabItem value="console" label="Console">
8484

85-
Head to the `Actions -> [action-name] -> Relationships` tab in the console for the action returning the output type.
85+
Head to the `Actions -> [action-name] -> Relationships` tab in the Console for the Action returning the output type.
8686

8787
Set the output type relationship as shown below:
8888

89-
<Thumbnail src='/img/actions/actions-relationship.png' alt='Console action relationship' />
89+
<Thumbnail src="/img/actions/actions-relationship.png" alt="Console action relationship" />
9090

9191
Hit `Save` to create the relationship.
9292

9393
</TabItem>
9494
<TabItem value="cli" label="CLI">
9595

96-
Go to `metadata/actions.yaml` in the Hasura project directory.
96+
Go to `metadata/actions.yaml` in the Hasura Project directory.
9797

9898
Update the definition of the `UpdateAuthorOutput` object type as:
9999

@@ -117,7 +117,7 @@ Save the changes and run `hasura metadata apply` to create the relationship.
117117
<TabItem value="api" label="API">
118118

119119
Action relationships can be added while defining custom types via the
120-
[set_custom_types](/api-reference/metadata-api/custom-types.mdx#metadata-set-custom-types) metadata API:
120+
[set_custom_types](/api-reference/metadata-api/custom-types.mdx#metadata-set-custom-types) Metadata API:
121121

122122
```http {20-29}
123123
POST /v1/metadata HTTP/1.1

docs/docs/actions/async-actions.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ query/subscribe to its status.
2323

2424
:::info Note
2525

26-
Only actions of type `mutation` can be async. Actions of type query are
26+
Only Actions of type `mutation` can be async. Actions of type query are
2727
always executed synchronously.
2828

2929
:::
@@ -52,7 +52,7 @@ action using this `action id`.
5252

5353
```graphql
5454
subscription getPlaceOrderResponse {
55-
place_order (id: "23b1c256-7aff-4b95-95bd-68220d9f93f2") {
55+
place_order(id: "23b1c256-7aff-4b95-95bd-68220d9f93f2") {
5656
output
5757
errors
5858
}

docs/docs/actions/codegen/index.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Codegen for Hasura actions
2+
description: Codegen for Hasura Actions
33
keywords:
44
- hasura
55
- docs
@@ -31,11 +31,11 @@ contributions from the community.
3131
<Tabs groupId="user-preference" className="api-tabs">
3232
<TabItem value="console" label="Console">
3333

34-
Head to the `Actions -> [action-name] -> Codegen` tab in the console
34+
Head to the `Actions -> [action-name] -> Codegen` tab in the Console
3535

3636
You can select the framework of your choice to get the corresponding handler boilerplate code.
3737

38-
<Thumbnail src='/img/actions/console-codegen-tab.png' alt='Console codegen tab' />
38+
<Thumbnail src="/img/actions/console-codegen-tab.png" alt="Console codegen tab" />
3939

4040
</TabItem>
4141
<TabItem value="cli" label="CLI">
@@ -52,14 +52,14 @@ hasura actions use-codegen
5252

5353
1. Choose which framework you want to codegen for:
5454

55-
<Thumbnail src='/img/actions/cli-framework-prompt.png' alt='CLI Framework Prompt' />
55+
<Thumbnail src="/img/actions/cli-framework-prompt.png" alt="CLI Framework Prompt" />
5656

5757
2. Choose if you also wish to clone a starter kit for the chosen framework:
5858

59-
<Thumbnail src='/img/actions/cli-starter-kit-prompt.png' alt='CLI Starter Kit Prompt' />
59+
<Thumbnail src="/img/actions/cli-starter-kit-prompt.png" alt="CLI Starter Kit Prompt" />
6060

6161
3. Choose a path where you want to output the auto-generated code files
62-
<Thumbnail src='/img/actions/cli-output-dir-prompt.png' alt='CLI Starter Kit Prompt' />
62+
<Thumbnail src="/img/actions/cli-output-dir-prompt.png" alt="CLI Starter Kit Prompt" />
6363

6464
This command will update your `config.yaml` with the codegen config as per your preferences. You can also set these
6565
values manually in `config.yaml`.
@@ -95,7 +95,7 @@ The codegen files will be generated at the `output_dir` path from `config.yaml`.
9595
## Codegen for your framework
9696

9797
As of now, Hasura provides codegen for a few frameworks (`nodejs-express`, `typescript-zeit`, `python-flask` and many
98-
more). You can see the full list in the `Codegen` tab on the console after you've
98+
more). You can see the full list in the `Codegen` tab on the Console after you've
9999
[created an action](/actions/create.mdx).
100100

101101
We will continue adding more examples to the documentation.

docs/docs/actions/codegen/python-flask.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_label: Python & Flask
33
sidebar_position: 1
4-
description: Codegen for Hasura actions in Python & Flask
4+
description: Codegen for Hasura Actions in Python & Flask
55
keywords:
66
- hasura
77
- docs
@@ -19,7 +19,7 @@ import Thumbnail from '@site/src/components/Thumbnail';
1919

2020
## Introduction
2121

22-
This page describes how to use Hasura actions and codegen to build a Python & Flask API for JWT authentication.
22+
This page describes how to use Hasura Actions and codegen to build a Python & Flask API for JWT authentication.
2323

2424
## Step 1: Create action definition & custom types
2525

@@ -56,10 +56,10 @@ type JsonWebToken {
5656
Example: creating the `Signup` action
5757

5858
<Thumbnail
59-
src='/img/actions/python-flask-signup-types.png'
60-
alt='Python Flask signup types'
61-
width='1000px'
62-
className='no-shadow'
59+
src="/img/actions/python-flask-signup-types.png"
60+
alt="Python Flask signup types"
61+
width="1000px"
62+
className="no-shadow"
6363
/>
6464

6565
## Step 2: Action handler implementation for signup
@@ -347,7 +347,7 @@ $ decode_jwt 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwib
347347

348348
## Step 5: Calling the finished actions
349349

350-
Try out your defined actions from the GraphQL API.
350+
Try out your defined Actions from the GraphQL API.
351351

352352
Call the `Signup` action:
353353

0 commit comments

Comments
 (0)