Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating "Migrating an Existing Subgraph to The Graph Network" page #37

Merged
merged 5 commits into from
Feb 3, 2022
Merged

Updating "Migrating an Existing Subgraph to The Graph Network" page #37

merged 5 commits into from
Feb 3, 2022

Conversation

ahmadmardeni1
Copy link
Contributor

  • I've fixed some readability issues.
  • Added "When not to Migrate?" section.
  • Added Curation Station links.

@ahmadmardeni1 ahmadmardeni1 requested a review from a team as a code owner January 20, 2022 20:20
Copy link
Member

@schmidsi schmidsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your input. I added a few comments.


If your subgraph:

- Is not generating too many queries, and at the same time you are not willing to self-signal.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea with this section. We should be careful about the wording here. Too little queries is not a reason to not migrate. Also self-signalling is not necessary a problem. But these are good reasons to not migrate:

  • Usage of IPFS
  • Usage of full-text search
  • Deployed on other chains than Ethereum mainnet

@@ -64,6 +71,8 @@ graph codegen && graph build

And that's it! After you are done publishing, you'll be able to view your subgraphs live on the network via [The Graph Explorer](https://thegraph.com/explorer).

Feel free to leverage the Curation Station (Unofficial) [Discord](https://discord.gg/GVfH3PgANH) and [Telegram](https://t.me/+RqzR_Y_a5eY2Zjdh) to let Curators know that your subgraph is ready to be signaled. It would also be helpful if you share your expected query volume with them.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are unofficial sources and we should not reference them on the public docs. But a paragraph that explains the general process of advertising a subgraph is definitely good. Main place for such thing is the official The Graph Discord: thegraph.com/discord

@ahmadmardeni1
Copy link
Contributor Author

Done. @schmidsi
Also, changed the expired link:

Capture

Copy link
Contributor

@azf20 azf20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for this PR! Some small wording suggestions in line


- Indexing [IPFS](https://ipfs.io/).
- Using [full-text search fields](https://thegraph.com/docs/en/developer/create-subgraph-hosted/#defining-fulltext-search-fields).
- Deployed on other chains than Ethereum mainnet.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Indexing chains other than Ethereum mainnet" might be slightly clearer here, just to be consistent across the documentation (subgraphs are deployed to an instance of Graph Node).

@@ -64,6 +72,8 @@ graph codegen && graph build

And that's it! After you are done publishing, you'll be able to view your subgraphs live on the network via [The Graph Explorer](https://thegraph.com/explorer).

Feel free to leverage the [#Curators channel](https://discord.gg/rC8rBuRtbH) on Discord to let Curators know that your subgraph is ready to be signaled. It would also be helpful if you share your expected query volume with them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Maybe works best to clarify how this information helps (maybe "Help curators by giving them some context about your subgraph, and its expected query volume")

@ahmadmardeni1
Copy link
Contributor Author

Done. @azf20

@nenadjaja nenadjaja merged commit 95fb677 into graphprotocol:main Feb 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants