Skip to content

Commit 36410be

Browse files
authored
Document v0.4.0 (#6)
1 parent e2f819f commit 36410be

16 files changed

+52
-22
lines changed

docs/aws-credentials.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
slug: aws-credentials
3+
sidebar_position: 10
4+
---
5+
6+
# 🔑 AWS credentials
7+
8+
GraphBolt only uses your local credentials in order to authenticate against your AWS accounts. Those credentials remain safe and secure. Everything happens on *your* machine.
9+
10+
We automatically detect the profiles that are configured in your credential files (e.g. `~/.aws/credentials` and/or `~/.aws/config`).
11+
12+
To start working from a specific account, pick a profile from the top bar.
13+
14+
![Profile Picker](img/profiles.png)
15+
16+
The following methods are supported:
17+
18+
### Short or long-term credentials
19+
20+
Those are the keys stored in the credentials file. i.e. `aws_access_key_id`, `aws_secret_access_key`, and optionally `aws_session_token`.
21+
22+
:::tip
23+
At GraphBolt, we recommend that you use [Leapp](https://leapp.cloud) in order to manage your short-term credentials.
24+
:::
25+
26+
### Single Sign-On
27+
28+
GraphBolt supports AWS Single Sign-On. If you have [configured SSO profiles](https://docs.aws.amazon.com/cli/latest/userguide/sso-configure-profile-token.html) on your local machine, GraphBolt will detect them and prompt you to login if necessary.
29+
30+
![SSO Login](img/sso.png)

docs/getting-started.md

-6
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,3 @@ description: GraphBolt is a desktop app for AWS AppSync. Build, manage, test and
1212
GraphBolt is the ultimate tool for AWS AppSync developers, providing a comprehensive solution for building, testing, and debugging GraphQL APIs.
1313

1414
![GraphBolt](./img/GraphBolt.png)
15-
16-
## Setup
17-
18-
The only thing you need to get started is to have your [AWS profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) configured on your machine. When you open GraphBolt, it will automatically detect them and discover all the AppSync APIs that you have in your accounts. You will find the available profiles in the top bar.
19-
20-
![AWS profiles](img/aws-profiles.png)

docs/graphql-client/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"position": 2,
2+
"position": 10,
33
"collapsible": true,
44
"collapsed": false
55
}

docs/graphql-client/subscriptions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ sidebar_position: 3
44

55
# Subscriptions
66

7-
GraphBolt supports GraphQL subscriptions. For now, you will only see the last received payload in the response view. Keeping message history is on the [roadmap](https://github.com/orgs/graphboltdev/projects/1/views/1?filterQuery=subsc&pane=issue&itemId=11954314) for future improvements.
7+
GraphBolt supports GraphQL subscriptions. For now, you will only see the last received payload in the response view.

docs/img/GraphBolt.png

552 KB
Loading

docs/img/aws-profiles.png

-26.3 KB
Binary file not shown.

docs/img/profiles.png

8.85 KB
Loading

docs/img/sso.png

30.1 KB
Loading
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"position": 4,
2+
"position": 30,
33
"collapsible": true,
44
"collapsed": false
55
}

docs/mapping-template-planner/code-evaluation.md

-5
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@ sidebar_position: 1
66

77
This tool allows you to quickly build and test your VTL mapping templates or AppSync JavaScript Resolvers. At the moment, this is nothing else than a friendly GUI for the [evaluate-mapping-template](https://docs.aws.amazon.com/cli/latest/reference/appsync/evaluate-mapping-template.html) and [evaluate-code](https://docs.aws.amazon.com/cli/latest/reference/appsync/evaluate-code.html) aws cli commands.
88

9-
:::info
10-
There are plans to allow executing the resulting JSON object against real data sources. See the [roadmap](https://github.com/orgs/graphboltdev/projects/1/views/1?filterQuery=mapping&pane=issue&itemId=11954302).
11-
:::
12-
13-
149
![Mapping template evaluation](./img/evaluation.png)
1510

1611
## 1. Context Object
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Collections
6+
7+
You can easily manage and categorize your resolvers by organizing them into collections. This feature enables you to perform the following actions:
8+
9+
- Create, edit, and delete JS resolvers or VTL mapping templates.
10+
- Group them logically into folders.
11+
- Quickly find specific resolvers using the filter function.
12+
13+
![Operation Collections](img/collections.png)
Loading

docs/query-inspector/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"position": 3,
2+
"position": 20,
33
"collapsible": true,
44
"collapsed": false
55
}

docs/query-inspector/query-details.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ This section gives you additional information about each field/resolver:
3434
| Resolver| The parent type and field name of the executed resolver. Next to it you'll see what kind of resolver it is (i.e. `Unit` or `Pipeline`), and icon (or icons) representing the underlying data source(s) that were used to resolve this field. |
3535
| Start offset| The difference in time between the beginning of this resolver invocation and the start of the request.|
3636
| Duration| How long this invocation of the resolver lasted.|
37-
| eye / 👁 | Click to see [resolver details](./resolver-details) |
37+
38+
39+
Click on a resolver to see [resolver details](./resolver-details)
3840

3941
# X-Ray
4042

docs/query-inspector/recent-queries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ On this screen, you will find a list of the queries that were recently executed,
88

99
You can filter the list by date-range, or by text (e.g. you can search for a specific operation name, or a request id).
1010

11-
By clicking on the 👁, you can get more information about a specific request. See the [Query details](query-details) section for more details.
11+
By clicking on a request, you can get more information about a specific request. See the [Query details](query-details) section for more details.
1212

1313
![Recent Queries](img/recent-queries.png)

docusaurus.config.js

+1-5
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,7 @@ const config = {
116116
{
117117
label: 'Blog',
118118
href: 'https://blog.graphbolt.dev',
119-
},
120-
{
121-
label: 'Roadmap',
122-
href: 'https://github.com/orgs/graphboltdev/projects/1',
123-
},
119+
}
124120
],
125121
},
126122
],

0 commit comments

Comments
 (0)