Skip to content

Commit adc13dd

Browse files
committed
Update tips.md with h2 ids.
1 parent 8ea522c commit adc13dd

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/source/fundamentals/tips.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ description: Your starting point for learning GraphQL and Apollo
55

66
TK WIP TODO finish this intro. Depending on the size of an organization, there are usually existing practices surrounding the management of the data
77

8-
## Adopt incrementally
8+
<h2 id="incremental-adoption">Incremental adoption</h2>
99

1010
While it makes an excellent longer-term goal, GraphQL doesn’t need to stand above the entire data tree in an organization in order to provide value and expending large amounts of engineering effort to switch an entire stack should generally be avoided.
1111

1212
Unlike some technologies, which are difficult to embrace without getting buy-in from all the teams in an organization, GraphQL can be utilized by smaller units (e.g. component by component, team by team) and later integrated into the bigger picture.
1313

1414
Thanks to GraphQL’s ability to fetch data from any data source, it makes sense to keep existing APIs as they are and use GraphQL to “wrap” the data. This can be appreciated by organizations with existing collections of REST (or similar) APIs which power their user experiences since they can lean heavily on their existing investments. This allows small teams to immediately realize many benefits of GraphQL without waiting for deeper adoption and allows existing versions of the application, which have already been deployed and rely on the existing API, to keep functioning uninterrupted.
1515

16-
## Schema scope and ownership
16+
<h2 id="schema">Schema scope and ownership</h2>
1717

1818
APIs change as the products which use them evolve and their ideal structure is usually defined by the front-end applications which consume them. While it’s certainly possible, and sometimes desirable, to have a single GraphQL schema which blankets an entire organization’s operational concerns, trying to manage a large schema presents challenges which are avoided by separating the schema into more manageable pieces that align with individual products.
1919

@@ -23,7 +23,7 @@ Having product teams own the GraphQL schema for their products allows the schema
2323

2424
Organizations looking to offer a single API endpoint can assemble the individual product schemas, managed by individual product teams into a monolithic API by “stitching” the various schemas together.
2525

26-
## Monitor GraphQL performance
26+
<h2 id="performance">Monitor GraphQL performance</h2>
2727

2828
An API implemented using GraphQL allows developers to query the exact information they desire from an API and nothing more. With proper visibility into how the API performs, developers can understand the implications of adding or removing fields, especially those which might be slow (notoriously or otherwise!).
2929

@@ -35,7 +35,7 @@ In addition to empowering front-end developers to make quick, educated decisions
3535

3636
This clarity allows pushing schema changes to production with the confidence of knowing that the API is performing as well as it was before, if not better!
3737

38-
## Write the server in JavaScript
38+
<h2 id="javascript">Write the server in JavaScript</h2>
3939

4040
Facebook's reference implementation has been written in JavaScript since its original release and fresh developments in the GraphQL ecosystem have frequently appeared first in JavaScript or languages which transpile to JavaScript, like TypeScript.
4141

0 commit comments

Comments
 (0)