Skip to content

Commit

Permalink
Fix Subgraph build
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesbayly committed Jun 19, 2024
1 parent c0f1273 commit 08758ee
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 14 deletions.
7 changes: 4 additions & 3 deletions docs/.vuepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -654,12 +654,13 @@ export const getSidebar = (locale: string) =>
],
},
{
text: "Architects",
link: `${locale}/subquery_network/architects/introduction.md`,
text: "Publish your Project",
link: `${locale}/subquery_network/architects/publish.md`,
collapsible: true,
children: [
`${locale}/subquery_network/architects/introduction.md`,
`${locale}/subquery_network/architects/publish.md`,
`${locale}/subquery_network/architects/publish-subgraph.md`,
`${locale}/subquery_network/architects/introduction.md`,
],
},
{
Expand Down
12 changes: 4 additions & 8 deletions docs/subquery_network/architects/publish-subgraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ The SubQuery Network is the future of web3 infrastructure, it allows you to comp

## Prerequisites for your Subgraph project running on the Network

1. The SubQuery Network does not support GraphQL subscriptions
2. Your project can generate stable proof of indexing results. Node Operator’s proof of indexing will be kept private
3. Your Subgraph deployment is published to IPFS
- You must have generated a unique IPFS CID for your SubGraph.

## Deploying your Subgraph Project

Expand All @@ -28,7 +26,7 @@ The SubQuery Network is a public permission-less network, anyone can deploy thei

You will need to publish your Subgraph project to IPFS first. Please enter the project CID and give your project a nice name.

![Publish - Enter CID and Name](/assets/img/network/architect_publish_subgraph.png)
![Publish - Enter CID and Name](/assets/img/network/architect_publish_ipfs.png)

On the next page you are asked to enter a project description, and also populate information about the project that Consumers or Node Operators might find interesting. This includes:

Expand All @@ -52,7 +50,7 @@ At this stage you should reach out to Node Operators in our Discord to encourage

You can easily make changes to your project or deploy a new version by accessing the Managed Project page.

![Manage Existing Project](/assets/img/network/architect_manage_subgraph_project.png)
![Manage Existing Project](/assets/img/network/architect_manage_project.png)

Firstly, you can publish a new version by clicking "Deploy New Version". This will let Node Operators know and allow them to upgrade to the new version of your Project. For the deployment you should provide:

Expand All @@ -61,8 +59,6 @@ Firstly, you can publish a new version by clicking "Deploy New Version". This wi
- check the box if you want to make this version recommended, this means that you are recommending Node Operators to immediately update to it. Don't check this if it's a test build or if it has major breaking changes
- the deployment description, which might include additional information for Node Operators about migration steps or breaking changes in this version

![Manage Existing Project - Deploy New Version](/assets/img/network/architect_manage_subgraph_project_deploy.png)

## Connect your dApp

To get started, create a Flex Plan and get your GraphQL endpoint [follow the guide here](../../consumers/plan.md)
To get started, create a Flex Plan and get your GraphQL endpoint [follow the guide here](../consumers/plan.md)
5 changes: 2 additions & 3 deletions docs/subquery_network/architects/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@ The SubQuery Network is the future of web3 infrastructure, it allows you to comp
## Prerequisites for your project running on the Network

1. The SubQuery Network does not support GraphQL subscriptions, so you can't enable the `--subscription` [command line argument](../../indexer/run_publish/query/subscription.md)
2. Your client application (the one that will query data) must be able to run a JS library
3. Your project can generate stable proof of indexing results. This means you should avoid:
2. Your project can generate stable proof of indexing results. This means you should avoid:
1. Random ordered DB operations, e.g. avoid using `Promise.all()` in your mapping functions.
2. Introducing external data dependent on runtime, e.g. initialising a new current date using `new Date()`.
4. Your project is published to IPFS, [follow the guide here](../../indexer/run_publish/publish.md#publish-your-subquery-project-to-ipfs).
3. Your project is published to IPFS, [follow the guide here](../../indexer/run_publish/publish.md#publish-your-subquery-project-to-ipfs).

## Deploying your Project

Expand Down

0 comments on commit 08758ee

Please sign in to comment.