Updating all pages #98
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
cc @schmidsi |
azf20
suggested changes
Apr 19, 2022
| ## Defining Entities | ||
|
|
||
| Before defining entities, it is important to take a step back and think about how your data is structured and linked. All queries will be made against the data model defined in the subgraph schema and the entities indexed by the subgraph. Because of this, it is good to define the subgraph schema in a way that matches the needs of your dapp. It may be useful to imagine entities as "objects containing data", rather than as events or functions. | ||
| Before defining entities, it is important to take a step back and think about how your data is structured and linked. All queries will be made against the data model defined in the subgraph schema and the entities indexed by the subgraph. Because of this, it is good to define the subgraph schema in a way that matches the needs of your dApp. It may be useful to imagine entities as "objects containing data", rather than as events or functions. |
There was a problem hiding this comment.
I believe we are standardising around dapp all lower case
| ``` | ||
|
|
||
| Each entity must have an `id` field, which is of type `ID!` (string). The `id` field serves as the primary key, and needs to be unique among all entities of the same type. | ||
| Each entity must have an `id` field, which is of type `ID!` (string). The `id` field serves as the primary key and needs to be unique among all entities of the same type. |
There was a problem hiding this comment.
I think this has been updated here https://github.com/graphprotocol/docs/pull/106/files#diff-2b4c73ecb9c1943d292714c57f5db379a9bb7c914ffdc92b0aa09caeacaed608R213
pages/en/developer/developer-faq.mdx
Outdated
| ### 2. Can I change my subgraph name? | ||
|
|
||
| No. Once a subgraph is created, the name cannot be changed. Make sure to think of this carefully before you create your subgraph so it is easily searchable and identifiable by other dapps. | ||
| No. Once a subgraph is created, the name cannot be changed. Make sure to think of this carefully before you create your subgraph so it is easily searchable and identifiable by other dApps. |
pages/en/developer/developer-faq.mdx
Outdated
| Unfortunately, this is currently not possible. `graph init` is intended as a basic starting point, from which you can then add more data sources manually. | ||
|
|
||
| ### 10. I want to contribute or add a GitHub issue, where can I find the open source repositories? | ||
| ### 10. I want to contribute or add a GitHub issue. Where can I find the open-source repositories? |
There was a problem hiding this comment.
I think we generally open source
pages/en/developer/developer-faq.mdx
Outdated
| ``` | ||
|
|
||
| ### 23. If my dapp frontend uses The Graph for querying, do I need to write my query key into the frontend directly? What if we pay query fees for users – will malicious users cause our query fees to be very high? | ||
| ### 23. If my dApp frontend uses The Graph for querying, do I need to write my query key into the frontend directly? What if we pay query fees for users – will malicious users cause our query fees to be very high? |
pages/en/explorer.mdx
Outdated
| --- | ||
|
|
||
| Welcome to the Graph Explorer, or as we like to call it, your decentralized portal into the world of subgraphs and network data. 👩🏽🚀 The Graph Explorer consists of multiple parts where you can interact with other subgraph developers, dapp developers, Curators, Indexers, and Delegators. For a general overview of the Graph Explorer, check out the video below (or keep reading below): | ||
| Welcome to the Graph Explorer, or as we like to call it, your decentralized portal into the world of subgraphs and network data. 👩🏽🚀 The Graph Explorer consists of multiple parts where you can interact with other subgraph developers, dApp developers, Curators, Indexers, and Delegators. For a general overview of the Graph Explorer, check out the video below (or keep reading below): |
| While you get to decide on your query budget, there is no guarantee that an Indexer will be willing to serve queries at that price. If a Gateway can match you to an Indexer willing to serve a query at, or lower than, the price you are willing to pay, you will pay the delta/difference of your budget **and** their price. As a consequence, a lower query price reduces the pool of Indexers available to you, which may affect the quality of service you receive. It's beneficial to have high query fees, as that may attract curation and big-name Indexers to your subgraph. | ||
|
|
||
| Remember that it's a dynamic and growing market, but how you interact with it is in your control. There is no maximum or minimum price specified in the protocol or the Gateways. For example, you can look at the price paid by a few of the dapps on the network (on a per-week basis), below. See the last column, which shows query fees in GRT. For example, [Pickle Finance](https://www.pickle.finance/) has 8 requests per second and paid 2.4 GRT for one week. | ||
| Remember that it's a dynamic and growing market, but how you interact with it is in your control. There is no maximum or minimum price specified in the protocol or the Gateways. For example, you can look at the price paid by a few of the dApps on the network (on a per-week basis), below. See the last column, which shows query fees in GRT. For example, [Pickle Finance](https://www.pickle.finance/) has 8 requests per second and paid 2.4 GRT for one week. |
| This section will walk you through deploying a subgraph to the Hosted Service, otherwise known as the [Hosted Service.](https://thegraph.com/hosted-service/) As a reminder, the Hosted Service will not be shut down soon. We will gradually sunset the Hosted Service once we reach feature parity with the decentralized network. Your subgraphs deployed on the Hosted Service are still available [here.](https://thegraph.com/hosted-service/) | ||
|
|
||
| If you don't have an account on the Hosted Service, you can signup with your Github account. Once you authenticate, you can start creating subgraphs through the UI and deploying them from your terminal. Graph Node supports a number of Ethereum testnets (Rinkeby, Ropsten, Kovan) in addition to mainnet. | ||
| If you don't have an account on the Hosted Service, you can signup with your Github account. Once you authenticate, you can start creating subgraphs through the UI and deploying them from your terminal. Graph Node supports several Ethereum testnets (Rinkeby, Ropsten, Kovan) in addition to mainnet. |
There was a problem hiding this comment.
I think this sentence understates the number of supported networks at this point, but that is perhaps outside the scope of this PR
pages/en/studio/subgraph-studio.mdx
Outdated
| Here in the Subgraph Studio, you have full control over your subgraphs. Not only can you test your subgraphs before you publish them, but you can also restrict your API keys to specific domains and only allow certain indexers to query from their API keys. | ||
|
|
||
| Querying subgraphs generates query fees, used to reward [indexers](/indexing) on the Graph network. If you’re a dapp developer or subgraph developer, the Studio will empower you to build better subgraphs to power your or your community’s queries. The Studio is comprised of 5 main parts: | ||
| Querying subgraphs generates query fees, used to reward [indexers](/indexing) on the Graph network. If you’re a dApp developer or subgraph developer, the Studio will empower you to build better subgraphs to power your or your community’s queries. The Studio is comprised of 5 main parts: |
pages/en/studio/subgraph-studio.mdx
Outdated
| ## Managing your API Keys | ||
|
|
||
| Regardless of whether you’re a dapp developer or a subgraph developer, you’ll need to manage your API keys. This is important for you to be able to query subgraphs because API keys make sure the connections between application services are valid and authorized. This includes authenticating the end user and the device using the application. | ||
| Regardless of whether you’re a dApp developer or a subgraph developer, you’ll need to manage your API keys. This is important for you to be able to query subgraphs because API keys make sure the connections between application services are valid and authorized. This includes authenticating the end-user and the device using the application. |
|
Hey Adam, thank you! @azf20 |
azf20
suggested changes
Apr 20, 2022
pages/en/studio/subgraph-studio.mdx
Outdated
| Here in the Subgraph Studio, you have full control over your subgraphs. Not only can you test your subgraphs before you publish them, but you can also restrict your API keys to specific domains and only allow certain indexers to query from their API keys. | ||
|
|
||
| Querying subgraphs generates query fees, used to reward [indexers](/indexing) on the Graph network. If you’re a dApp developer or subgraph developer, the Studio will empower you to build better subgraphs to power your or your community’s queries. The Studio is comprised of 5 main parts: | ||
| Querying subgraphs generates query fees, used to reward [indexers](/indexing) on the Graph network. If you’re a dpp developer or subgraph developer, the Studio will empower you to build better subgraphs to power your or your community’s queries. The Studio is comprised of 5 main parts: |
|
Oh sorry, didn't notice the comment. |
|
Thanks @ahmadmardeni1! I still see two conflicts? Sorry if they were more recently introduced |
|
Yes, they were recently introduced. No problem, just resolved them! @azf20 |
azf20
approved these changes
Apr 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've made more than 100 edits, some of them are:
I've spent a lot of time on this and updated all pages, so please let me know if there are any edits required.