Skip to content

Commit 4c85246

Browse files
arif-hanifrstaib
arif-hanif
and
rstaib
authoredAug 25, 2021
Updated Banana Cake Pop Documentation (#4111)
Co-authored-by: Rafael Staib <me@rafaelstaib.com>
·
16.0.0-p.111.3.6
1 parent 930df8c commit 4c85246

30 files changed

+203
-15
lines changed
 

‎website/src/docs/bananacakepop/actions/key-bindings.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: "Key Bindings"
3+
---
4+
5+
The following key bindings can be used as shortcuts to common actions in Banana Cake Pop.
6+
7+
### Mac
8+
9+
- Open new tab: ⌘ + ⌥ + T
10+
- Save current tab: ⌘ + S
11+
- Open Document Explorer: ⌘ + ⌥ + D
12+
- Open History Explorer: ⌘ + ⌥ + H
13+
- Format Document: ⇧ + ⌥ + F
14+
15+
### Windows
16+
17+
- Open new tab: CTRL + ALT + T
18+
- Save current tab: CTRL + S
19+
- Open Document Explorer: CTRL + SHIFT + D
20+
- Open History Explorer: CTRL + SHIFT + H
21+
- Format Document: SHIFT + ALT + F

‎website/src/docs/bananacakepop/actions/schema-refresh.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: "Schema Refresh"
3+
---
4+
5+
You can refresh the schema if it is out of sync with the server by using the following key bindings, or by click the reload schema icon next to the endpoint.
6+
7+
Mac: ⇧ + ⌥ + ⏎
8+
9+
Windows: SHIFT + ALT + ENTER

‎website/src/docs/bananacakepop/documents/headers.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: "Document Headers"
3+
---

‎website/src/docs/bananacakepop/documents/history.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: "History Explorer"
3+
---

‎website/src/docs/bananacakepop/documents/linting.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: "Linting"
3+
---

‎website/src/docs/bananacakepop/documents/managing.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Managing Documents"
3+
---
4+
5+
The documents explorer allows you to see and organize your documents. You have the ability to create new, rename, edit and delete.
6+
7+
### Creating new document
8+
9+
1. To create a new document click the +File button.
10+
11+
### Renaming a document
12+
13+
### Editing a document
14+
15+
### Deleting a document

‎website/src/docs/bananacakepop/documents/tabs.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: "Document Tabs"
3+
---

‎website/src/docs/bananacakepop/documents/variables.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: "Document Variables"
3+
---

‎website/src/docs/bananacakepop/getting-started.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: "Getting Started"
3+
---
4+
5+
Welcome to Banana Cake Pop!
6+
When you enter the application it will look like below. Fairly minimal until you enter a GraphQL endpoint.
7+
8+
![Banana Cake Pop - Start](../shared/bcp/bcp-start-screen.png)
9+
10+
Lets get going with Banana Cake Pop and make our first GraphQL request. If you do not have a GraphQL API you can use the mock API below provided by ChilliCream.
11+
12+
Endpoint: https://workshop.chillicream.cloud/graphql
13+
14+
After entering your endpoint and hitting enter, your Banana Cake Pop workspace should fill with "Operations" and "Response" area like seen below.
15+
16+
![Banana Cake Pop - Endpoint Entry](../shared/bcp/bcp-endpoint-entry.png)
17+
18+
You can now copy and paste the query below into the "Operations" editor area and hit the "Run" button which should return a response in the "Response" area with data.
19+
20+
```graphql
21+
{
22+
sessionById(id: "U2Vzc2lvbgppMQ==") {
23+
title
24+
track {
25+
name
26+
}
27+
startTime
28+
endTime
29+
}
30+
}
31+
```
32+
33+
![Banana Cake Pop - Sessions By Id Query](../shared/bcp/bcp-sessionsbyid-query.png)
34+
35+
Congratulations, you have completed a GraphQL query. Next lets check out the [Schema Reference](/docs/bananacakepop/schema-reference) area so we can explore the API and learn about it

‎website/src/docs/bananacakepop/index.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,16 @@
22
title: "Introduction"
33
---
44

5-
You are looking for the download version of our GraphQL IDE?
5+
Banana Cake Pop makes it easy and enjoyable to test your GraphQL server implementations. It works well with Hot Chocolate and any other GraphQL server. Try it out and give us feedback via [slack](http://slack.chillicream.com/) in the ** #banana-cake-pop ** channel .
66

7-
We are getting ready for the next big release of Banana Cake Pop. You can already try out the preview version [here](http://workshop.chillicream.cloud).
7+
# Download
88

9-
The new download version should be available in the next couple of days.
9+
Banana Cake Pop is currently in preview and the current version is `1.0.0-preview.1`. It has an auto update feature built in, so as new releases come out you will get notifications in the app.
10+
11+
- [MacOS Installer](https://download.chillicream.com/bananacakepop/BananaCakePop-1.0.0-preview.1.dmg)
12+
- [Windows Installer](https://download.chillicream.com/bananacakepop/BananaCakePop-1.0.0-preview.1.exe)
13+
- [Ubuntu Installer](https://download.chillicream.com/bananacakepop/BananaCakePop-1.0.0-preview.1.AppImage)
14+
15+
After downloading head over to [getting started](/docs/bananacakepop/getting-started) and lets make our first GraphQL query in Banana Cake Pop.
16+
17+
![Banana Cake Pop - Operations](../shared/bcp/bcp-operations.png)

‎website/src/docs/bananacakepop/integrations/apollo.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Banana Cake Pop - Apollo Server"
3+
---
4+
5+
Coming soon!

‎website/src/docs/bananacakepop/integrations/express.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Banana Cake Pop - Express Integration"
3+
---
4+
5+
Coming soon!

‎website/src/docs/bananacakepop/integrations/gatsby.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Banana Cake Pop - Gatsby Integration"
3+
---
4+
5+
Coming soon!

‎website/src/docs/bananacakepop/integrations/hot-chocolate.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: "HotChocolate Middleware"
3+
---

‎website/src/docs/bananacakepop/integrations/index.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Introduction"
3+
---
4+
5+
We are working on a number of integrations for Banana Cake Pop, currently it is built into Hot Chocolate.
6+
7+
The following integrations are coming soon.
8+
9+
- [Express](/docs/bananacakepop/integrations/express)
10+
- [Koa](/docs/bananacakepop/integrations/koa)
11+
- [Gatsby](/docs/bananacakepop/integrations/gatsby)
12+
- [Apollo Server](/docs/bananacakepop/integrations/apollo)

‎website/src/docs/bananacakepop/integrations/koa.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Banana Cake Pop - Koa Integration"
3+
---
4+
5+
Coming soon!

‎website/src/docs/bananacakepop/schema-definition.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Schema Definition"
3+
---
4+
5+
The "Schema Definition" part of Banana Cake Pop allows you to see the raw Schema Definition Language (SDL) of your GraphQL server.
6+
7+
To access the definition click the dropdown where it says "Operations" and select "Schema Definition".
8+
9+
![Banana Cake Pop - Editor dropdown](../shared/bcp/bcp-editor-dropdown.png)
10+
11+
This will change the workspace area from "Operations" and "Response" to "Schema Definition".
12+
13+
You can either explore the SDL in the editor or download it by click the download icon in the top right hand corner of the "Schema Definition" area.
14+
15+
![Banana Cake Pop - Schema Definition](../shared/bcp/bcp-schema-definition.png)

‎website/src/docs/bananacakepop/schema-reference.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Schema Reference"
3+
---
4+
5+
The Schema Reference part of Banana Cake Pop allows you to learn about the types in your GraphQL API.
6+
7+
To access the reference click the dropdown where it says "Operations" and select "Schema Reference".
8+
9+
![Banana Cake Pop - Editor dropdown](../shared/bcp/bcp-editor-dropdown.png)
10+
11+
This will change the workspace area from "Operations" and "Response" to "Schema Reference" and "Types".
12+
13+
You will by default see the root "Query" type which has all the queries on your API. On the right hand side of the screen you can start to search for specific types to interrogate there specific fields.
14+
15+
![Banana Cake Pop - Schema Reference](../shared/bcp/bcp-schema-reference-query-type.png)

‎website/src/docs/docs.json

+20
Original file line numberDiff line numberDiff line change
@@ -504,6 +504,26 @@
504504
{
505505
"path": "index",
506506
"title": "Introduction"
507+
},
508+
{
509+
"path": "getting-started",
510+
"title": "Getting Started"
511+
},
512+
{
513+
"path": "schema-reference",
514+
"title": "Schema Reference"
515+
},
516+
{
517+
"path": "schema-definition",
518+
"title": "Schema Definition"
519+
},
520+
{
521+
"path": "actions",
522+
"title": "Actions",
523+
"items": [
524+
{ "path": "schema-refresh", "title": "Schema Refresh" },
525+
{ "path": "key-bindings", "title": "Key Bindings" }
526+
]
507527
}
508528
]
509529
}

‎website/src/docs/shared/bcp/bcp-document-explorer.png

52.9 KB
Loading

‎website/src/docs/shared/bcp/bcp-editor-dropdown.png

90 KB
Loading

‎website/src/docs/shared/bcp/bcp-endpoint-entry.png

39 KB
Loading

‎website/src/docs/shared/bcp/bcp-operations.png

183 KB
Loading

‎website/src/docs/shared/bcp/bcp-schema-definition.png

83.9 KB
Loading

‎website/src/docs/shared/bcp/bcp-schema-reference-query-type.png

127 KB
Loading

‎website/src/docs/shared/bcp/bcp-sessions-query.png

128 KB
Loading

‎website/src/docs/shared/bcp/bcp-sessionsbyid-query.png

87.4 KB
Loading

‎website/src/docs/shared/bcp/bcp-start-screen.png

39 KB
Loading

‎website/src/images/banana-cake-pop.png

6.37 KB
Loading

‎website/src/pages/index.tsx

+12-12
Original file line numberDiff line numberDiff line change
@@ -105,27 +105,27 @@ const IndexPage: FC = () => {
105105
showThumbs={false}
106106
>
107107
<Slide>
108-
<Link to="/blog/2021/03/31/chillicream-platform-11-1">
109-
<BlogPostChilliCreamPlatform />
110-
</Link>
111-
</Slide>
112-
<Slide>
113-
<Link to="/blog/2020/11/23/hot-chocolate-11">
114-
<BlogPostVersion11 />
115-
</Link>
116-
</Slide>
117-
<Slide>
118-
<Link to="/docs/bananacakepop">
108+
<Link to="https://bananacakepop.com">
119109
<BananaCakePop shadow />
120110
<SlideContent>
121-
<SlideTitle>Banana Cake Pop</SlideTitle>
111+
<SlideTitle>Try Banana Cake Pop Preview 1</SlideTitle>
122112
<SlideDescription>
123113
Our GraphQL IDE to explore schemas, execute operations and get
124114
deep performance insights.
125115
</SlideDescription>
126116
</SlideContent>
127117
</Link>
128118
</Slide>
119+
<Slide>
120+
<Link to="/blog/2021/03/31/chillicream-platform-11-1">
121+
<BlogPostChilliCreamPlatform />
122+
</Link>
123+
</Slide>
124+
<Slide>
125+
<Link to="/blog/2020/11/23/hot-chocolate-11">
126+
<BlogPostVersion11 />
127+
</Link>
128+
</Slide>
129129
<Slide>
130130
<Link to="/blog/2020/03/18/entity-framework">
131131
<BlogPostEFMeetsGraphQL />

0 commit comments

Comments
 (0)
Please sign in to comment.