mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-22 15:01:39 +03:00
8a999bd44d
### Description This PR does several things: - it cleans up some structural issues with the engineering documentation: - it harmonizes the table of contents structure across different files - adds a link to the bigquery documentation - moves some files to a new `deep-dives` subfolder - puts a title at the top of each page to avoid github assuming their title is "table of contents" - it pre-fills the glossary with a long list of words that could use an entry (all empty for now) - it adds the only remaining relevant server file from [hasura-internal's wiki](https://github.com/hasura/graphql-engine-internal/wiki): the old "multiple backends architecture" file ### Discussion A few things worth discussing in the scope of this PR: - is it worth migrating old documentation such as the multiple backends architecture, that document a decision process rather instead of being up-to-date reflections of the code? are we planning to delete hasura-internal? - should we focus instead on _new_ documentation, aimed to be kept up to date? - are there other old documents we want to move in here, or is that it? - is this glossary structure ok, or would a purely alphabetical structure make sense? - does it make sense to have the glossary only in the engineering section? more generally, _what's our broader plan for documentation_? PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4537 GitOrigin-RevId: c2b674657b19af7a75f66a2a304c80c30f5b0afb
103 lines
1.8 KiB
Markdown
103 lines
1.8 KiB
Markdown
# Glossary
|
|
|
|
<!--
|
|
Please make sure you update the table of contents when modifying this file. If
|
|
you're using emacs, you can generate a default version of it with `M-x
|
|
markdown-toc-refresh-toc` (provided by the package markdown-toc), and then edit
|
|
it for readability.
|
|
-->
|
|
|
|
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
|
|
|
|
- [Product](#product)
|
|
- [Actions](#actions)
|
|
- [Data connectors](#data-connectors)
|
|
- [Event triggers](#event-triggers)
|
|
- [GDW](#gdw)
|
|
- [GraphQL Data Wrappers](#graphql-data-wrappers)
|
|
- [Metadata](#metadata)
|
|
- [Relationships](#relationships)
|
|
- [Relay](#relay)
|
|
- [Remote relationships](#remote-relationships)
|
|
- [Source](#source)
|
|
- [Schema cache](#schema-cache)
|
|
- [GraphQL](#graphql)
|
|
- [Introspection](#introspection)
|
|
- [Mutations](#mutations)
|
|
- [Queries](#queries)
|
|
- [Query root](#query-root)
|
|
- [Schema](#schema)
|
|
- [Subscriptions](#subscriptions)
|
|
- [Livequeries](#livequeries)
|
|
- [Haskell](#haskell)
|
|
- [Existential types](#existential-types)
|
|
- [Implementation](#implementation)
|
|
- [Field](#field)
|
|
- [IR](#ir)
|
|
- [Parser](#parser)
|
|
- [RQL](#rql)
|
|
|
|
<!-- markdown-toc end -->
|
|
|
|
## Product
|
|
|
|
### Actions
|
|
|
|
### Data connectors
|
|
|
|
### Event triggers
|
|
|
|
### GDW
|
|
|
|
See [GraphQL Data Wrappers](#graphql-data-wrappers).
|
|
|
|
### GraphQL Data Wrappers
|
|
|
|
Original name of [Data connectors](#data-connectors).
|
|
|
|
### Metadata
|
|
|
|
### Relationships
|
|
|
|
### Relay
|
|
|
|
### Remote relationships
|
|
|
|
### Source
|
|
|
|
### Schema cache
|
|
|
|
## GraphQL
|
|
|
|
See the [spec](http://spec.graphql.org/June2018).
|
|
|
|
### Introspection
|
|
|
|
### Mutations
|
|
|
|
### Queries
|
|
|
|
### Query root
|
|
|
|
### Schema
|
|
|
|
### Subscriptions
|
|
|
|
### Livequeries
|
|
|
|
See [Subscriptions](#subscriptions).
|
|
|
|
## Haskell
|
|
|
|
### Existential types
|
|
|
|
## Implementation
|
|
|
|
### Field
|
|
|
|
### IR
|
|
|
|
### Parser
|
|
|
|
### RQL
|