Skip to content

Commit bec2d52

Browse files
committed
some updates
1 parent 09dcb08 commit bec2d52

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,26 @@ Learn how to deploy your subgraph in Subgraph Studio.
1111
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 through Studio UI
15-
- Deploy your subgraph using the CLI
14+
- Create your subgraph through the Studio UI
15+
- Deploy your subgraph using the The Graph CLI
1616
- Publish your subgraph with the Studio UI
1717
- Stage your subgraph in the playground environment
1818
- Integrate your subgraph in staging using the query URL
1919
- Restrict your API keys to specific domains and allow only certain Indexers to query with them
2020

21-
In [Subgraph Studio](https://thegraph.com/studio/), you can view the following:
21+
You can also view the following:
2222

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

29-
## Install the Graph CLI
29+
## Install The Graph CLI
3030

3131
Before deploying, you must install The Graph CLI.
3232

33-
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.
33+
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.
3434

3535
**Install with yarn:**
3636

@@ -56,13 +56,13 @@ Before deploying your subgraph you need to create a subgraph in [Subgraph Studio
5656
3. After you sign in, your unique deploy key will be displayed on your account home page.
5757
- The deploy key allows you to publish your subgraphs or manage your API keys and billing. It is unique but can be regenerated if you think it has been compromised.
5858

59-
> Important: You need API keys to query subgraphs
59+
> Important: You need an API key to query subgraphs
6060
6161
#### How to Create a Subgraph in Subgraph Studio
6262

6363
<VideoEmbed youtube="nGIFuC69bSA" />
6464

65-
> For additional written detail, review the [quick-start](/quick-start/)
65+
> For additional written detail, review the [Quick-Start](/quick-start/).
6666
6767
#### Subgraph Compatibility with The Graph Network
6868

@@ -76,7 +76,7 @@ In order to be supported by Indexers on The Graph Network, subgraphs must:
7676

7777
## Initialize your Subgraph
7878

79-
Once your subgraph has been created in Subgraph Studio, you can initialize the subgraph code through the CLI using this command:
79+
Once your subgraph has been created in Subgraph Studio, you can initialize its code through the CLI using this command:
8080

8181
```bash
8282
graph init --studio <SUBGRAPH_SLUG>
@@ -90,7 +90,7 @@ After running `graph init`, you will be asked to input the contract address, net
9090

9191
## Graph Auth
9292

93-
Before you can deploy your subgraph to Subgraph Studio, you need to login into your account within 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.
93+
Before you can deploy your subgraph to Subgraph Studio, you need to login into your account within the CLI. To do this, you will need your deploy key, which you can find under your subgraph details page.
9494

9595
Then, use the following command to authenticate from the CLI:
9696

@@ -112,12 +112,12 @@ graph deploy --studio <SUBGRAPH_SLUG>
112112

113113
After running this command, the CLI will ask for a version label.
114114

115-
- 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`.
115+
- 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`, or `asdf`.
116116
- 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.
117117

118118
## Testing your Subgraph
119119

120-
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.
120+
After deploying, you can test/stage your subgraph (either in Subgraph Studio or in your own app, with the deployment query URL), deploy another version, update the metadata, and publish to [Graph Explorer](https://thegraph.com/explorer) when you are ready.
121121

122122
Use Subgraph Studio’s playground to check your subgraph logs and see where a subgraph fails.
123123

@@ -129,18 +129,18 @@ In order to publish your subgraph successfully, review [publishing a subgraph](/
129129

130130
If you want to update your subgraph, you can do the following:
131131

132-
- You can deploy a new version to the Studio using the CLI (it will only be private at this point).
132+
- You can deploy a new version to Studio using the CLI (it will only be private at this point).
133133
- Once you're happy with it, you can publish your new deployment to [Graph Explorer](https://thegraph.com/explorer).
134134
- This action will create a new version of your subgraph that curators can start signaling on and Indexers can index.
135135

136-
You can also update your subgraphs' metadata without publishing a new version. You can update your subgraph details in the Studio (under the profile picture, name, description, etc.) by checking an option called **Update Details** in Graph Explorer. If this is checked, an on-chain transaction will be generated that updates subgraph details in the Explorer without having to publish a new version with a new deployment.
136+
You can also update your subgraph's metadata without publishing a new version. You can update your subgraph details in Studio (under the profile picture, name, description, etc.) by checking an option called **Update Details** in Graph Explorer. If this is checked, an on-chain transaction will be generated that updates subgraph details in Explorer without having to publish a new version with a new deployment.
137137

138-
> Note: There are costs associated with publishing a new version of a subgraph to the network. In addition to the transaction fees, you must also fund a part of the curation tax on the auto-migrating signal. You cannot publish a new version of your subgraph if curators have not signaled on it. For more information on the risks of curation, please read more [here](/network/curating/).
138+
> Note: There are costs associated with publishing a new version of a subgraph to the network. In addition to the transaction fees, you must also fund a part of the curation tax on the auto-migrating signal. You cannot publish a new version of your subgraph if Curators have not signaled on it. For more information on the risks of curation, please read more [here](/network/curating/).
139139
140140
## Automatic Archiving of Subgraph Versions
141141

142-
Whenever you deploy a new subgraph version in Subgraph Studio, the previous version will be archived. Archived versions won't be indexed/synced and therefore cannot be queried. You can unarchive an archived version of your subgraph in the Studio UI.
142+
Whenever you deploy a new subgraph version in Subgraph Studio, the previous version will be archived. Archived versions won't be indexed/synced and therefore cannot be queried. You can unarchive an archived version of your subgraph in Studio UI.
143143

144-
> Note: Previous versions of non-published subgraphs deployed to the Studio will be automatically archived.
144+
> Note: Previous versions of non-published subgraphs deployed to Studio will be automatically archived.
145145
146146
![Subgraph Studio - Unarchive](/img/Unarchive.png)

0 commit comments

Comments
 (0)