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

Subgraph Best Practices 5 and 6 #825

Merged
merged 25 commits into from
Dec 12, 2024
Merged

Subgraph Best Practices 5 and 6 #825

merged 25 commits into from
Dec 12, 2024

Conversation

marcusrein
Copy link
Member

Added Subgraph Best Practice 5 and Subgraph Best Practice 6 after peer review process was completed.

Updated formatting and added links to the bottom of each Subgraph Best Practice as well to improve congruency of this cookbook series.

Thanks!

@marcusrein marcusrein requested a review from a team as a code owner November 27, 2024 18:12
Copy link
Contributor

@idalithb idalithb left a comment

Choose a reason for hiding this comment

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

These are terrific! Great explanations @marcusrein 🔥

website/pages/en/cookbook/avoid-eth-calls.mdx Outdated Show resolved Hide resolved

## Subgraph Best Practices 1-6

1. [Improve Query Speed with Subgraph Pruning](https://thegraph.com/docs/en/cookbook/pruning/)
Copy link
Contributor

Choose a reason for hiding this comment

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

All

Suggested change
1. [Improve Query Speed with Subgraph Pruning](https://thegraph.com/docs/en/cookbook/pruning/)
1. [Improve Query Speed with Subgraph Pruning](/cookbook/pruning/)

You should make this modification to all links
@benface correct me if I'm wrong here

Copy link
Contributor

Choose a reason for hiding this comment

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

Links that are within the docs*

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, because absolute links have the language (English) hardcoded in them, whereas relative ones keep the current language (and the href is copied over as-is to translated pages).

website/pages/en/cookbook/derivedfrom.mdx Outdated Show resolved Hide resolved
website/pages/en/cookbook/derivedfrom.mdx Outdated Show resolved Hide resolved
website/pages/en/cookbook/grafting-hotfix.mdx Outdated Show resolved Hide resolved

## Why Timeseries and Aggregations Are a Best Practice

1. Improved Indexing Time • Less Data to Load: Mappings handle less data since raw data points are stored as immutable timeseries entities. • Database-Managed Aggregations: Aggregations are automatically computed by the database, reducing the workload on the mappings.
Copy link
Contributor

Choose a reason for hiding this comment

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

Spacing issue that's distorting the formatting. I think the bullet point are suppose to be below the numbers, right?

website/pages/en/cookbook/timeseries.mdx Outdated Show resolved Hide resolved
website/pages/en/cookbook/timeseries.mdx Outdated Show resolved Hide resolved
website/pages/en/cookbook/timeseries.mdx Outdated Show resolved Hide resolved
website/pages/en/cookbook/timeseries.mdx Show resolved Hide resolved
Copy link
Member Author

@marcusrein marcusrein left a comment

Choose a reason for hiding this comment

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

I like your changes @idalithb !

Feel free to move forward with your suggestions. Thank you!

MichaelMacaulay and others added 17 commits December 11, 2024 14:10
@idalithb idalithb requested review from idalithb and benface December 11, 2024 19:35
Copy link
Contributor

@idalithb idalithb left a comment

Choose a reason for hiding this comment

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

Yay! 🥳

website/pages/en/cookbook/grafting-hotfix.mdx Show resolved Hide resolved
@benface benface merged commit e674dea into main Dec 12, 2024
3 checks passed
@benface benface deleted the subgraph-best-practice-5-6 branch December 12, 2024 15:13
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