hasura / hasura/graphql-engine

docs: add a page for performance best practices

Open
#8,246 1 comment 3 reactions 0 assignees View on GitHub
c/docs k/enhancement
Dominant language
TypeScript
Stars
32.1k
Forks
3k
PR merge metrics
PR metrics pending

Description

add a section in docs with best practices and tips to improve performance

a few sample points:

- analyzing queries to figure out bottlenecks
- setting up db indexes
- combining multiple requests into one if possible
- recommended DB connections configuration
- optimising subscriptions

[Useful resoruce](https://github.com/hgiasac/blog-builder/blob/master/pages/posts/2020-05-15-Tuning-Hasura-at-Scale.md).

Contributor guide

Open the contributing guide

Research direction

Inspect the existing documentation structure first, then read the linked Hasura performance resource for context. Create a performance best-practices section covering query bottlenecks, database indexes and connections, request consolidation, and subscription optimization; done means the guidance is clearly organized in the appropriate docs location.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql
Domain
backend-api-design, documentation, performance
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.