add guides/resources section to docs (#694)

This commit is contained in:
Matthew Holman 2018-10-11 06:29:53 -05:00 committed by Shahidh K Muhammed
parent a8abc40ece
commit bf71b17274
8 changed files with 88 additions and 27 deletions

View File

@ -14,7 +14,7 @@ Choose from the following guides to deploy the Hasura GraphQL engine and connect
- :doc:`Deploy using Docker <docker/index>`
- :doc:`Deploy using Kubernetes <kubernetes/index>`
Also see :doc:`../guides/deployment/index` for more specific examples.
You can also check :doc:`../guides/deployment/index` for more specific examples.
By default, Hasura GraphQL engine runs in a very permissive mode for easier development. Check out the below pages
to configure Hasura GraphQL engine for your production environment:
@ -23,9 +23,9 @@ to configure Hasura GraphQL engine for your production environment:
- :doc:`postgres-permissions`
- :doc:`GraphQL engine server configuration <graphql-engine-flags/index>`
For access to Hasura GraphQL engine server logs, check the below page for details:
For access to Hasura GraphQL engine logs, check the below page for details:
- :doc:`Server logs <logging>`
- :doc:`Logging <logging>`
.. toctree::

View File

@ -1,5 +1,5 @@
Hasura GraphQL engine server logs
=================================
Hasura GraphQL engine logs
==========================
Based on your deployment method, Hasura GraphQL engine logs can be accessed as follows:
@ -13,9 +13,4 @@ Monitoring frameworks
You can integrate the logs emitted by Hasura GraphQL with external monitoring tools for better visibility as per
your convenience.
For example, the following blog posts demonstrate integrating Hasura GraphQL engine logs with some external
monitoring frameworks:
- `GraphQL Observability with Hasura GraphQL Engine and Honeycomb <https://blog.hasura.io/graphql-observability-with-hasura-graphql-engine-and-honeycomb-ee0a1a836c41>`_
- `Uptime Monitoring for Hasura GraphQL Engine with DataDog on GKE <https://blog.hasura.io/uptime-monitoring-for-hasura-graphql-engine-with-datadog-on-gke-4faff5832e7f>`_
For some examples, see :doc:`../guides/monitoring/index`

View File

@ -1,12 +1,16 @@
Deployment guides
=================
Guides: Deployment
==================
- :doc:`Deploy on Digital Ocean using Docker <digital-ocean>`
.. note::
The above are guides to deploy Hasura GraphQL engine on some specific platforms.
For more generic guides, see :doc:`../../deployment/index`
.. toctree::
:maxdepth: 1
:titlesonly:
:hidden:
On Digital Ocean using Docker <digital-ocean>
On Digital Ocean using Docker <digital-ocean>

View File

@ -1,14 +1,55 @@
Guides
======
Guides / Tutorials / Resources
==============================
Deployment guides
-----------------
- :doc:`Deploy on Digital Ocean using Docker <deployment/digital-ocean>`
.. note::
The above are guides to deploy Hasura GraphQL engine on some specific platforms.
For more generic guides, see :doc:`../deployment/index`
Sample apps
-----------
Articles:
^^^^^^^^^
- `Build a realtime chat app with GraphQL Subscriptions <https://blog.hasura.io/building-a-realtime-chat-app-with-graphql-subscriptions-d68cd33e73f>`_.
- `Build a React To Do Application <https://hackernoon.com/building-a-react-todo-app-with-hasura-graphql-engine-511b703a7ef>`_.
Videos:
^^^^^^^
- `Build a realtime chat app with GraphQL Subscriptions <https://www.youtube.com/watch?v=xNcxdGaUGqI>`_.
Integration/migration tutorials
-------------------------------
Articles:
^^^^^^^^^
- `Move from firebase to realtime GraphQL on Postgres <https://blog.hasura.io/firebase2graphql-moving-from-firebase-to-realtime-graphql-on-postgres-4d36cb7f4eaf>`_.
- `Create a Gatsby site using GraphQL on Postgres <https://blog.hasura.io/create-gatsby-sites-using-graphql-on-postgres-603b5dd1e516>`_.
- `Instant GraphQL on AWS RDS <https://blog.hasura.io/instant-graphql-on-aws-rds-1edfb85b5985>`_.
- `Using TimescaleDB with Hasura GraphQL <https://blog.hasura.io/using-timescaledb-with-hasura-graphql-d05f030c4b10>`_.
Integrating with monitoring frameworks
--------------------------------------
The following demonstrate integrating Hasura GraphQL engine logs with some external
monitoring frameworks:
Articles:
^^^^^^^^^
- `GraphQL Observability with Hasura GraphQL Engine and Honeycomb <https://blog.hasura.io/graphql-observability-with-hasura-graphql-engine-and-honeycomb-ee0a1a836c41>`_
- `Uptime Monitoring for Hasura GraphQL Engine with DataDog on GKE <https://blog.hasura.io/uptime-monitoring-for-hasura-graphql-engine-with-datadog-on-gke-4faff5832e7f>`_
.. toctree::
:maxdepth: 1
:titlesonly:
:hidden:
deployment/index
Deployment guides <deployment/index>
Sample apps <sample-apps/index>
Integration/migration tutorials <integrations/index>
Integrating with monitoring frameworks <monitoring/index>

View File

@ -0,0 +1,9 @@
Guides: Integration/migration tutorials
=======================================
Articles:
^^^^^^^^^
- `Move from firebase to realtime GraphQL on Postgres <https://blog.hasura.io/firebase2graphql-moving-from-firebase-to-realtime-graphql-on-postgres-4d36cb7f4eaf>`_.
- `Create a Gatsby site using GraphQL on Postgres <https://blog.hasura.io/create-gatsby-sites-using-graphql-on-postgres-603b5dd1e516>`_.
- `Instant GraphQL on AWS RDS <https://blog.hasura.io/instant-graphql-on-aws-rds-1edfb85b5985>`_.
- `Using TimescaleDB with Hasura GraphQL <https://blog.hasura.io/using-timescaledb-with-hasura-graphql-d05f030c4b10>`_.

View File

@ -0,0 +1,10 @@
Guides: Integrating with monitoring frameworks
----------------------------------------------
The following demonstrate integrating Hasura GraphQL engine logs with some external
monitoring frameworks:
Articles:
^^^^^^^^^
- `GraphQL Observability with Hasura GraphQL Engine and Honeycomb <https://blog.hasura.io/graphql-observability-with-hasura-graphql-engine-and-honeycomb-ee0a1a836c41>`_
- `Uptime Monitoring for Hasura GraphQL Engine with DataDog on GKE <https://blog.hasura.io/uptime-monitoring-for-hasura-graphql-engine-with-datadog-on-gke-4faff5832e7f>`_

View File

@ -0,0 +1,11 @@
Guides: Sample apps
===================
Articles:
^^^^^^^^^
- `Build a realtime chat app with GraphQL Subscriptions <https://blog.hasura.io/building-a-realtime-chat-app-with-graphql-subscriptions-d68cd33e73f>`_.
- `Build a React To Do Application <https://hackernoon.com/building-a-react-todo-app-with-hasura-graphql-engine-511b703a7ef>`_.
Videos:
^^^^^^^
- `Build a realtime chat app with GraphQL Subscriptions <https://www.youtube.com/watch?v=xNcxdGaUGqI>`_.

View File

@ -1,9 +0,0 @@
5 min tutorial
==============
- Setup
- Define schema
- Query
- Mutation
- Live queries, events
- Permission