graphprotocol / graphprotocol/docs
document steps to publish a subgraph to the network that is not supported by studio
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 85
- Forks
- 162
- Avg merge
- 6h 31m
- Merged PRs (30d)
- 4
Description
It is possible to publish subgraphs on the network that are not supported in studio. This process should be well documented, and aligned with the upcoming changes to the CLI.
Perhaps CLI and docs changes should be made together? @alex-pakalniskis
For this flow:
A developer should
- write substreams module, test it, make sure it works (if a substreams powered subgraph)
- write subgraph with triggers that uses that substreams package (or just a normal subgraph)
- test it locally with local instance of graph node
- deploy on the decentralized network with the cli tool "graph publish" and ask indexers on the Graph server to pick it up (which channel in discord should they ask?)
- start querying it
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing documentation for the CLI flow and the upcoming CLI changes mentioned in the issue. Document the five-step path from writing and testing a subgraph through local Graph Node testing, graph publish, contacting indexers, and querying the deployed subgraph; include the appropriate Discord channel if confirmed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cli
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100