Skip to content

Commit a1dc3be

Browse files
committed
Deploying-a -subgraph
1 parent 3a11d06 commit a1dc3be

File tree

1 file changed

+23
-30
lines changed

1 file changed

+23
-30
lines changed

website/pages/en/deploying/deploying-a-subgraph-to-studio.mdx

Lines changed: 23 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
---
2-
title: Deploying a Subgraph to Subgraph Studio
2+
title: Deploy Using Subgraph Studio
33
---
44

5-
> Before deploying, you must install The Graph CLI; please review [Creating a Subgraph]()
5+
Learn how to deploy your subgraph in Subgraph Studio.
66

7-
When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to stage it. It's important to remember that deploying is not the same as publishing. When you publish a subgraph, you are publishing it on-chain.
7+
> Note: When you deploy a subgraph, you push it to Subgraph Studio, where you'll be able to stage it. It's important to remember that deploying is not the same as publishing. When you publish a subgraph, you are publishing it on-chain.
88
9-
## What can you do in Subgraph Studio?
9+
## Subgraph Studio Overview
1010

11-
[Subgraph Studio]() allows you to do the following:
11+
In [Subgraph Studio](https://thegraph.com/studio/), you can do the following:
1212

1313
- Create and manage your API keys for specific subgraphs
14-
- Create your Subgraph in Subgraph Studio
14+
- Create your subgraph
1515
- Authenticate your account from the CLI
16-
- Deploy a Subgraph to Subgraph Studio
17-
- Stage it in the playground environment
18-
- Integrate it in staging using the query URL
16+
- Deploy your subgraph
17+
- Stage your subgraph in the playground environment
18+
- Integrate your subgraph in staging using the query URL
1919

20-
In Subgraph Studio, you can view the following:
20+
In [Subgraph Studio](https://thegraph.com/studio/), you can view the following:
2121

2222
- Your user account controls
2323
- A list of subgraphs you've created
2424
- A section to manage your API keys
2525
- A section to manage, view details, and visualize the status of a specific subgraph
2626
- A section to manage your billing
2727

28-
Step-by-Step
29-
3028
## Install the Graph CLI
3129

30+
Before deploying, you must install The Graph CLI.
31+
3232
You must have [Node.js](https://nodejs.org/) and a package manager of your choice (`npm`, `yarn` or `pnpm`) installed to use the Graph CLI. Check for the [most recent](https://github.com/graphprotocol/graph-tooling/releases?q=%40graphprotocol%2Fgraph-cli&expanded=true) CLI version.
3333

3434
**Install with yarn:**
@@ -43,7 +43,7 @@ yarn global add @graphprotocol/graph-cli
4343
npm install -g @graphprotocol/graph-cli
4444
```
4545

46-
## Create your Subgraph in Subgraph Studio
46+
## Create your subgraph
4747

4848
### Create an account
4949

@@ -63,7 +63,7 @@ Before deploying your subgraph you need to create a subgraph in [Subgraph Studio
6363

6464
<VideoEmbed youtube="nGIFuC69bSA" />
6565

66-
> For additional written detail, review the [quick-start]()
66+
> For additional written detail, review the [quick-start](/quick-start/)
6767
6868
#### Subgraph Compatibility with The Graph Network
6969

@@ -75,7 +75,7 @@ In order to be supported by Indexers on The Graph Network, subgraphs must:
7575
- Non-fatal errors
7676
- Grafting
7777

78-
## Initialize your Subgraph
78+
## Initialize your subgraph
7979

8080
Once your subgraph has been created in Subgraph Studio you can initialize the subgraph code using this command:
8181

@@ -87,21 +87,19 @@ You can view the `<SUBGRAPH_SLUG>` value on your subgraph details page in Subgra
8787

8888
![Subgraph Studio - Slug](/img/doc-subgraph-slug.png)
8989

90-
After running `graph init`, you will be asked to input the contract address, network, and ABI that you want to query.
91-
92-
- This will generate a new folder on your local machine with some basic code to start working on your subgraph. You can then finalize your subgraph to make sure it works as expected.
90+
After running `graph init`, you will be asked to input the contract address, network, and an ABI that you want to query. This will generate a new folder on your local machine with some basic code to start working on your subgraph. You can then finalize your subgraph to make sure it works as expected.
9391

9492
## Graph Auth
9593

96-
Before can deploy your subgraph to Subgraph Studio, you must login into your account using the CLI. To do this, you will need your deploy key (you can find it on your "My Subgraphs" page or under your subgraph details page).
94+
Before can deploy your subgraph to Subgraph Studio, you must login into your account using the CLI. To do this, you will need your deploy key, which you can find on your "My Subgraphs" page or under your subgraph details page.
9795

9896
Then, use the following command to authenticate from the CLI:
9997

10098
```bash
10199
graph auth --studio <DEPLOY KEY>
102100
```
103101

104-
## Deploying a Subgraph to Subgraph Studio
102+
## Deploying a subgraph
105103

106104
Once you are ready, you can deploy your subgraph to Subgraph Studio.
107105

@@ -118,19 +116,14 @@ After running this command, the CLI will ask for a version label.
118116
- It's strongly recommended to use [semver](https://semver.org/) for versioning like `0.0.1`. That said, you are free to choose any string as version such as:`v1`, `version1`, `asdf`.
119117
- The labels you create will be visible in Graph Explorer and can be used by curators to decide if they want to signal on a specific version or not, so choose them wisely.
120118

121-
## Testing your Subgraph
119+
## Testing your subgraph
122120

123-
After deploying, you can test/stage your subgraph in Subgraph Studio, deploy another version, update the metadata, and publish to Graph Explorer when you are ready.
121+
After deploying, you can test/stage your subgraph in Subgraph Studio, deploy another version, update the metadata, and publish to [Graph Explorer](https://thegraph.com/explorer) when you are ready.
124122

125-
Use Subgraph Studio’s playground to:
123+
Use Subgraph Studio’s playground to check your subgraph logs and see where a subgraph fails.
126124

127-
- Check your subgraph logs
128-
- The subgraph logs will indicate if and where a subgraph fails.
129-
130-
## Publish your Subgraph in Subgraph Studio
125+
## Publish your subgraph
131126

132127
You are now ready to publish your subgraph!
133128

134-
In order to publish your subgraph successfully, review [publishing a subgraph] (/publishing/publishing-a-subgraph/).
135-
136-
<VideoEmbed youtube="satdwdbvzAQ" />
129+
In order to publish your subgraph successfully, review [publishing a subgraph](/publishing/publishing-a-subgraph/).

0 commit comments

Comments
 (0)