From 3b8ad7bda0b2cc3c5fad768821a0a58bcfba920f Mon Sep 17 00:00:00 2001 From: Marcus Rein <64141593+marcusrein@users.noreply.github.com> Date: Tue, 14 Jan 2025 08:08:37 -0500 Subject: [PATCH 1/7] quickstart updates --- website/pages/en/subgraphs/quick-start.mdx | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/website/pages/en/subgraphs/quick-start.mdx b/website/pages/en/subgraphs/quick-start.mdx index 7e50fd69be14..824809728dff 100644 --- a/website/pages/en/subgraphs/quick-start.mdx +++ b/website/pages/en/subgraphs/quick-start.mdx @@ -49,7 +49,7 @@ The following command initializes your subgraph from an existing contract: graph init ``` -If your contract was verified on Etherscan, then the ABI will automatically be created in the CLI. +If your contract was verified, then the ABI will automatically be created in the CLI. When you initialize your subgraph, the CLI will ask you for the following information: @@ -82,11 +82,7 @@ For a detailed breakdown on how to write your subgraph, check out [Creating a Su ### 5. Deploy your subgraph -Remember, deploying is not the same as publishing. - -When you deploy a subgraph, you push it to [Subgraph Studio](https://thegraph.com/studio/), where you can test, stage and review it. - -When you publish a subgraph, you are publishing it onchain to the decentralized network. +When you **deploy** a subgraph, you push it to [Subgraph Studio](https://thegraph.com/studio/), where you can test, stage and review it. A deployed subgraph's indexing is performed by the [Upgrade Indexer](https://thegraph.com/blog/upgrade-indexer/) a single Indexer owned and operated by Edge & Node, not by the many decentralized Indexers in The Graph Network. A **deployed** subgraph is free to use, rate-limited, not visible to the public, and meant to be used for development, staging, and testing purposes. Once your subgraph is written, run the following commands: @@ -119,7 +115,9 @@ If you’d like to test your subgraph before publishing it, you can use [Subgrap ### 7. Publish your subgraph to The Graph Network -Publishing a subgraph to the decentralized network is an onchain action that makes your subgraph available for [Curators](/resources/roles/curating/) to curate it and [Indexers](/indexing/overview/) to index it. +When your subgraph is ready for a production environment, you can publish it to the decentralized network. Publishing a subgraph means that your subgraph becomes availble to index by the decentralized Indexers on The Graph Network. Publishing also removes rate limits, and makes your subgraph publicly searchable and queriable on [The Graph Explorer](https://thegraph.com/explorer/). + +Publishing a subgraph to the decentralized network is an onchain action that makes your subgraph available for [Curators](/resources/roles/curating/) to curate it and [Indexers](/indexing/overview/) to index it. The greater the amount of GRT you and others curate on your subgraph, the more Indexers will be incentivized to index your subgraph, improving the quality of service, reducing latency, and enhancing network redundancy and availability for your subgraph. #### Publishing with Subgraph Studio From cf4ffe883135979bac40a0d814e107fc0c5edbbe Mon Sep 17 00:00:00 2001 From: Marcus Rein <64141593+marcusrein@users.noreply.github.com> Date: Tue, 14 Jan 2025 09:05:28 -0500 Subject: [PATCH 2/7] small edits --- website/pages/en/subgraphs/quick-start.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/pages/en/subgraphs/quick-start.mdx b/website/pages/en/subgraphs/quick-start.mdx index 824809728dff..fea4b382122d 100644 --- a/website/pages/en/subgraphs/quick-start.mdx +++ b/website/pages/en/subgraphs/quick-start.mdx @@ -117,7 +117,7 @@ If you’d like to test your subgraph before publishing it, you can use [Subgrap When your subgraph is ready for a production environment, you can publish it to the decentralized network. Publishing a subgraph means that your subgraph becomes availble to index by the decentralized Indexers on The Graph Network. Publishing also removes rate limits, and makes your subgraph publicly searchable and queriable on [The Graph Explorer](https://thegraph.com/explorer/). -Publishing a subgraph to the decentralized network is an onchain action that makes your subgraph available for [Curators](/resources/roles/curating/) to curate it and [Indexers](/indexing/overview/) to index it. The greater the amount of GRT you and others curate on your subgraph, the more Indexers will be incentivized to index your subgraph, improving the quality of service, reducing latency, and enhancing network redundancy and availability for your subgraph. +Publishing a subgraph to the decentralized network is an onchain action that makes your subgraph available for [Curators](/resources/roles/curating/) to curate it and [Indexers](/indexing/overview/) to index it. The greater the amount of GRT you and others curate on your subgraph, the more Indexers will be incentivized to index your subgraph, improving the quality of service, reducing latency, and enhancing network redundancy for your subgraph. #### Publishing with Subgraph Studio From 370dc907749b79f96bf7552255c69f2636658c6e Mon Sep 17 00:00:00 2001 From: Marcus Rein <64141593+marcusrein@users.noreply.github.com> Date: Tue, 14 Jan 2025 16:11:43 -0500 Subject: [PATCH 3/7] Update subgraphs/quick-start.mdx: Improve clarity. Referenced PR comments. --- website/pages/en/subgraphs/quick-start.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/pages/en/subgraphs/quick-start.mdx b/website/pages/en/subgraphs/quick-start.mdx index fea4b382122d..0842d551630d 100644 --- a/website/pages/en/subgraphs/quick-start.mdx +++ b/website/pages/en/subgraphs/quick-start.mdx @@ -49,7 +49,7 @@ The following command initializes your subgraph from an existing contract: graph init ``` -If your contract was verified, then the ABI will automatically be created in the CLI. +If your contract is verified on the respective blockscanner where it is deployed (such as [Etherscan](https://etherscan.io/)), then the ABI will automatically be created in the CLI. When you initialize your subgraph, the CLI will ask you for the following information: @@ -82,6 +82,8 @@ For a detailed breakdown on how to write your subgraph, check out [Creating a Su ### 5. Deploy your subgraph +Deploying a subgraph is not the same as publishing a subgraph. + When you **deploy** a subgraph, you push it to [Subgraph Studio](https://thegraph.com/studio/), where you can test, stage and review it. A deployed subgraph's indexing is performed by the [Upgrade Indexer](https://thegraph.com/blog/upgrade-indexer/) a single Indexer owned and operated by Edge & Node, not by the many decentralized Indexers in The Graph Network. A **deployed** subgraph is free to use, rate-limited, not visible to the public, and meant to be used for development, staging, and testing purposes. Once your subgraph is written, run the following commands: @@ -115,9 +117,7 @@ If you’d like to test your subgraph before publishing it, you can use [Subgrap ### 7. Publish your subgraph to The Graph Network -When your subgraph is ready for a production environment, you can publish it to the decentralized network. Publishing a subgraph means that your subgraph becomes availble to index by the decentralized Indexers on The Graph Network. Publishing also removes rate limits, and makes your subgraph publicly searchable and queriable on [The Graph Explorer](https://thegraph.com/explorer/). - -Publishing a subgraph to the decentralized network is an onchain action that makes your subgraph available for [Curators](/resources/roles/curating/) to curate it and [Indexers](/indexing/overview/) to index it. The greater the amount of GRT you and others curate on your subgraph, the more Indexers will be incentivized to index your subgraph, improving the quality of service, reducing latency, and enhancing network redundancy for your subgraph. +When your subgraph is production-ready, you can **publish** it to the decentralized network. This process makes your subgraph available for indexing by decentralized Indexers on The Graph Network, removes rate limits, and allows it to be publicly searchable and queryable on [The Graph Explorer](https://thegraph.com/explorer/). Publishing is an onchain action that enables [Curators](/resources/roles/curating/) to curate and [Indexers](/indexing/overview/) to index your subgraph. The more GRT curated on your subgraph, the more Indexers are incentivized to index it, enhancing service quality, reducing latency, and improving network redundancy. #### Publishing with Subgraph Studio From 2624db6e37d5c87457844d9c6dfc1db626691922 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Rouleau?= Date: Tue, 14 Jan 2025 22:14:28 +0100 Subject: [PATCH 4/7] Update website/pages/en/subgraphs/quick-start.mdx Co-authored-by: Idalith <126833353+idalithb@users.noreply.github.com> --- website/pages/en/subgraphs/quick-start.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/pages/en/subgraphs/quick-start.mdx b/website/pages/en/subgraphs/quick-start.mdx index 0842d551630d..c39059088a77 100644 --- a/website/pages/en/subgraphs/quick-start.mdx +++ b/website/pages/en/subgraphs/quick-start.mdx @@ -84,7 +84,8 @@ For a detailed breakdown on how to write your subgraph, check out [Creating a Su Deploying a subgraph is not the same as publishing a subgraph. -When you **deploy** a subgraph, you push it to [Subgraph Studio](https://thegraph.com/studio/), where you can test, stage and review it. A deployed subgraph's indexing is performed by the [Upgrade Indexer](https://thegraph.com/blog/upgrade-indexer/) a single Indexer owned and operated by Edge & Node, not by the many decentralized Indexers in The Graph Network. A **deployed** subgraph is free to use, rate-limited, not visible to the public, and meant to be used for development, staging, and testing purposes. +> Remember, deploying is not the same as publishing. +When you **deploy** a subgraph, you push it to [Subgraph Studio](https://thegraph.com/studio/), where you can test, stage and review it. A deployed subgraph's indexing is performed by the [Upgrade Indexer](https://thegraph.com/blog/upgrade-indexer/), which is a single Indexer owned and operated by Edge & Node, rather than by the many decentralized Indexers in The Graph Network. A **deployed** subgraph is free to use, rate-limited, not visible to the public, and meant to be used for development, staging, and testing purposes. Once your subgraph is written, run the following commands: From d98d73b635d48336dc2e98d62998763fbef5bea1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Rouleau?= Date: Tue, 14 Jan 2025 22:15:30 +0100 Subject: [PATCH 5/7] Update website/pages/en/subgraphs/quick-start.mdx --- website/pages/en/subgraphs/quick-start.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/website/pages/en/subgraphs/quick-start.mdx b/website/pages/en/subgraphs/quick-start.mdx index c39059088a77..0e0e26aeb958 100644 --- a/website/pages/en/subgraphs/quick-start.mdx +++ b/website/pages/en/subgraphs/quick-start.mdx @@ -82,8 +82,6 @@ For a detailed breakdown on how to write your subgraph, check out [Creating a Su ### 5. Deploy your subgraph -Deploying a subgraph is not the same as publishing a subgraph. - > Remember, deploying is not the same as publishing. When you **deploy** a subgraph, you push it to [Subgraph Studio](https://thegraph.com/studio/), where you can test, stage and review it. A deployed subgraph's indexing is performed by the [Upgrade Indexer](https://thegraph.com/blog/upgrade-indexer/), which is a single Indexer owned and operated by Edge & Node, rather than by the many decentralized Indexers in The Graph Network. A **deployed** subgraph is free to use, rate-limited, not visible to the public, and meant to be used for development, staging, and testing purposes. From 5cdde7d83cea1df7d6ecd6adc28b81bcd6922546 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Rouleau?= Date: Tue, 14 Jan 2025 22:15:46 +0100 Subject: [PATCH 6/7] Update website/pages/en/subgraphs/quick-start.mdx --- website/pages/en/subgraphs/quick-start.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/website/pages/en/subgraphs/quick-start.mdx b/website/pages/en/subgraphs/quick-start.mdx index 0e0e26aeb958..3464531eccbe 100644 --- a/website/pages/en/subgraphs/quick-start.mdx +++ b/website/pages/en/subgraphs/quick-start.mdx @@ -83,6 +83,7 @@ For a detailed breakdown on how to write your subgraph, check out [Creating a Su ### 5. Deploy your subgraph > Remember, deploying is not the same as publishing. + When you **deploy** a subgraph, you push it to [Subgraph Studio](https://thegraph.com/studio/), where you can test, stage and review it. A deployed subgraph's indexing is performed by the [Upgrade Indexer](https://thegraph.com/blog/upgrade-indexer/), which is a single Indexer owned and operated by Edge & Node, rather than by the many decentralized Indexers in The Graph Network. A **deployed** subgraph is free to use, rate-limited, not visible to the public, and meant to be used for development, staging, and testing purposes. Once your subgraph is written, run the following commands: From fb52260a41913fe9922bf5e217d0cbe060252970 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beno=C3=AEt=20Rouleau?= Date: Tue, 14 Jan 2025 22:24:03 +0100 Subject: [PATCH 7/7] Update website/pages/en/subgraphs/quick-start.mdx --- website/pages/en/subgraphs/quick-start.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/website/pages/en/subgraphs/quick-start.mdx b/website/pages/en/subgraphs/quick-start.mdx index 3464531eccbe..176b59d4133d 100644 --- a/website/pages/en/subgraphs/quick-start.mdx +++ b/website/pages/en/subgraphs/quick-start.mdx @@ -117,7 +117,13 @@ If you’d like to test your subgraph before publishing it, you can use [Subgrap ### 7. Publish your subgraph to The Graph Network -When your subgraph is production-ready, you can **publish** it to the decentralized network. This process makes your subgraph available for indexing by decentralized Indexers on The Graph Network, removes rate limits, and allows it to be publicly searchable and queryable on [The Graph Explorer](https://thegraph.com/explorer/). Publishing is an onchain action that enables [Curators](/resources/roles/curating/) to curate and [Indexers](/indexing/overview/) to index your subgraph. The more GRT curated on your subgraph, the more Indexers are incentivized to index it, enhancing service quality, reducing latency, and improving network redundancy. +When your subgraph is ready for a production environment, you can publish it to the decentralized network. Publishing is an onchain action that does the following: + +- It makes your subgraph available to be to indexed by the decentralized [Indexers](/indexing/overview/) on The Graph Network. +- It removes rate limits and makes your subgraph publicly searchable and queryable in [Graph Explorer](https://thegraph.com/explorer/). +- It makes your subgraph available for [Curators](/resources/roles/curating/) to curate it. + +> The greater the amount of GRT you and others curate on your subgraph, the more Indexers will be incentivized to index your subgraph, improving the quality of service, reducing latency, and enhancing network redundancy for your subgraph. #### Publishing with Subgraph Studio