hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00
Code Issues Projects Releases Wiki Activity

docs: misc updates

Browse Source 
- update cloud pricing plan names
- add supported from/in notes
- add config.yaml version note for using config v2
- nitpicks

GitOrigin-RevId: 4c06efb15cbec650fd38162f4d3b71d13c6ee56e
This commit is contained in:
Rikin Kachhia 2021-03-17 19:13:59 +05:30 committed by hasura-bot
parent 8103589b79
commit 0c2a40c740
8 changed files with 37 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/graphql/cloud/metrics/integrations/datadog.rst
View File

@ -20,7 +20,7 @@ on the integrations tab on the project's setting page.
.. note::
Datadog Integration is only available for Hasura Cloud projects on the Standard (pay-as-you-go) tier.
Datadog Integration is only available for Hasura Cloud projects on the ``Standard`` (pay-as-you-go) tier and above.
Configure Datadog Integration
-----------------------------

4
docs/graphql/cloud/projects/ownership.rst
View File

@ -20,7 +20,7 @@ owner will lose all access to the project.
.. note::
If the project is on the Standard (pay-as-you-go) tier, the new owner will pay for the entire data usage for the month in which the ownership is transferred.
If the project is on the ``Standard`` (pay-as-you-go) tier, the new owner will pay for the entire data usage for the month in which the ownership is transferred.
Send an ownership transfer invitation
-------------------------------------
@ -63,5 +63,5 @@ You can accept an invitation by clicking on the ``Accept`` button.
.. note::
If the project is on the Standard (pay-as-you-go) tier, the new owner must have an active card
If the project is on the ``Standard`` (pay-as-you-go) tier, the new owner must have an active card
associated with their Hasura Cloud account to accept the invitation.

32
docs/graphql/cloud/projects/pricing.rst
View File

@ -23,8 +23,8 @@ Pricing plans
There are three different pricing plans that you can chose from:
- Free tier
- Pay-as-you-go
- Free
- Standard (Pay-as-you-go)
- Enterprise
.. note::
@ -44,38 +44,38 @@ By clicking on the ``Projects`` tab, you can see all your projects and what plan
Switching pricing plans
-----------------------
Switch from free tier to pay-as-you-go
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Switch from **Free** to **Standard** tier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once the free tier data limit is exhausted, the project becomes inactive. In order to keep it active, you can switch to the pay-as-you-go plan.
Once the ``Free`` tier data limit is exhausted, the project becomes inactive. In order to keep it active, you can switch to the ``Standard`` plan.
Go to ``Projects`` and click on the project you'd like to change.
Now click on the ``Usage tab``. To upgrade to the pay-as-you-go plan, click on the ``Upgrade`` button:
Now click on the ``Usage tab``. To upgrade to the ``Standard`` plan, click on the ``Upgrade`` button:
.. thumbnail:: /img/graphql/cloud/projects/upgrade-to-paid-plan.png
:alt: Upgrade to the pay-as-you-go plan
:alt: Upgrade to the Standard plan
:width: 1200px
:class: inline-block
Your project is now running on the pay-as-you-go plan.
Your project is now running on the ``Standard`` plan.
Switch from pay-as-you-go to free tier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Switch from **Standard** to **Free** tier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Go to ``Projects`` and click on the project you'd like to change.
Now click on the ``Usage`` tab and then click on the link ``Switch to the free tier`` on the bottom right:
.. thumbnail:: /img/graphql/cloud/projects/switch-to-free-plan.png
:alt: Switch from pay-as-you-go to free tier
:alt: Switch from Standard to Free tier
:width: 1200px
:class: inline-block
You'll be charged as per the pay-as-you-go plan until the end of the day. From the next day onwards, the project will be on the free tier.
If the free tier limit is exhausted, the project might become inactive.
You'll be charged as per the ``Standard`` plan until the end of the day. From the next day onwards, the project will be on the ``Free`` tier.
If the ``Free`` tier limit is exhausted, the project might become inactive.
Switch to and from enterprise
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Switch to and from **Enterprise** tier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In order to upgrade to the enterprise plan or to switch back to another plan, please `contact our sales team <https://hasura.io/contact-us/?type=hasuraenterprise>`__.
In order to upgrade to the ``Enterprise`` plan or to switch back to another plan, please `contact our sales team <https://hasura.io/contact-us/?type=hasuraenterprise>`__.

4
docs/graphql/cloud/response-caching.rst
View File

@ -26,6 +26,10 @@ A query's response can be cached only if the following conditions hold:
- The query does not make use of remote schemas or remote joins
- The response JSON is under 100KB in size
.. admonition:: Support
Query response caching is available for Hasura Cloud projects on the ``Standard`` (pay-as-you-go) tier and above.
Enable caching
--------------

2
docs/graphql/core/api-reference/syntax-defs.rst
View File

@ -103,7 +103,7 @@ PGConfiguration
* - read_replicas
- false
- [PGSourceConnectionInfo_]
- Optional list of read replica configuration
- Optional list of read replica configuration *(supported only in cloud/enterprise versions)*
.. _PGSourceConnectionInfo:

10
docs/graphql/core/auth/authorization/inherited-roles.rst
View File

@ -32,7 +32,7 @@ Inherited roles are useful when you need to define multiple permission rules (ma
Inherited roles are supported for versions ``v2.0.0-alpha.4`` and above.
Creating Inherited roles
Creating inherited roles
------------------------
.. rst-class:: api_tabs
@ -40,7 +40,7 @@ Creating Inherited roles
.. tab:: Console
Go to the ``Settings`` tab on the console and click on ``Inherited Roles``.
Go to the ``Settings`` tab (⚙) on the console and click on ``Inherited Roles``.
.. thumbnail:: /img/graphql/core/auth/console-inherited-role.png
:alt: Console create inherited role
@ -128,8 +128,10 @@ The other parameters of the select permission will be combined in the following
2. Allow aggregations - If any of the role allows aggregation, then the inherited role will allow aggregation
3. Scalar computed fields - same as table column fields, as in the above example
Accessibility of a field to an inherited role is defined as follows:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Accessibility of a field for an inherited role
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Accessibility of a field for an inherited role is defined as follows:
1. When all the roles give access to a column ``C``, then ``C`` will
always be accessible.

2
docs/graphql/core/deployment/graphql-engine-flags/config-examples.rst
View File

@ -171,7 +171,7 @@ the right content-type headers.
Hasura follows a rolling update pattern for console releases where assets for
a ``major.minor`` version is updated continuously across all patches. If
you're using the assets on the server with a Docker image, it might not be the latest
version of console.
version of the console.
.. _dev-mode:

8
docs/graphql/core/migrations/upgrade-v3.rst
View File

@ -217,9 +217,9 @@ If you are starting hasura with a ``HASURA_GRAPHQL_DATABASE_URL`` then the name
Continue using config v2
------------------------
It is possible to continue using ``config v2`` with Hasura ``v2.0.0`` and above if you would like to do so.
It is possible to continue using ``config v2`` with Hasura versions ``v2.0.0`` and above if you would like to do so.
While using ``config v2`` with Hasura ``v2.0.0`` and above, as we have metadata and migrations for only a single database,
While using ``config v2`` with Hasura versions ``v2.0.0`` and above, as we have metadata and migrations for only a single database,
the server assumes that they belong to a database named ``default`` and attempts to apply them to it.
Hence, to continue using ``config v2`` we need to connect a database to Hasura GraphQL engine with the name ``default`` and then run
@ -232,3 +232,7 @@ any metadata and migrations commands.
Post this, the metadata and migration commands should work as usual.
.. note::
Ensure the ``version`` key in ``config.yaml`` is set to ``2`` while using ``config v2``