docs: restructure cloud project section (#5809)

This commit is contained in:
Rikin Kachhia 2020-09-21 15:30:21 +05:30 committed by GitHub
parent f01bedd8ff
commit c3d8b5ddcc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 43 additions and 99 deletions

View File

@ -63,7 +63,7 @@ Step 4: Try Hasura out
Click ``Launch Console`` to open the Hasura console in your browser and
:ref:`make your first GraphQL query <first_graphql_query>` or :ref:`set up your first event trigger <first_event_trigger>`.
.. thumbnail:: /img/graphql/cloud/getting-started/project-functionalities.png
.. thumbnail:: /img/graphql/cloud/getting-started/project-launch-console.png
:alt: Project actions
:width: 860px
@ -79,11 +79,11 @@ Next steps
You can check out our `30-Minute Hasura Basics Course <https://hasura.io/learn/graphql/hasura/introduction/>`__
and other `GraphQL & Hasura Courses <https://hasura.io/learn/>`__ for a more detailed introduction to Hasura.
You can also click the gear icon to :ref:`manage your Hasura Cloud project <manage_project>` (e.g. add
collaborators, env vars or custom domains) and :ref:`add an admin secret <secure_project>` to make sure that your
GraphQL endpoint and the Hasura console are not publicly accessible.
You can also click the gear icon to manage your Hasura Cloud project. (e.g. add :ref:`collaborators <manage_project_collaborators>`,
:ref:`env vars <manage_project_env_vars>` or :ref:`custom domains <manage_project_domains>`) and :ref:`add an admin secret <secure_project>`
to make sure that your GraphQL endpoint and the Hasura console are not publicly accessible.
.. thumbnail:: /img/graphql/cloud/getting-started/project-functionalities.png
.. thumbnail:: /img/graphql/cloud/getting-started/project-manage.png
:alt: Project actions
:width: 860px

View File

@ -25,7 +25,10 @@ realtime monitoring, caching, tracing, and rate-limiting. It supports both new a
.. container:: toc-list-content
- :ref:`cloud_getting_started`
- :ref:`projects`
- :ref:`create_project`
- :ref:`manage_project_collaborators`
- :ref:`manage_project_env_vars`
- :ref:`secure_project`
.. container:: toc-list-section

View File

@ -1,11 +1,11 @@
.. meta::
:description: Managing teams on Hasura Cloud
:keywords: hasura, docs, project, team
:description: Managing collaborators on Hasura Cloud
:keywords: hasura, docs, project, team, collaborators
.. _manage_project_team:
.. _manage_project_collaborators:
Team tab
========
Project Collaborators
=====================
.. contents:: Table of contents
:backlinks: none
@ -22,14 +22,14 @@ Add a collaborator
Click ``New Collaborator`` to invite a new team member.
.. thumbnail:: /img/graphql/cloud/projects/team-view.png
:alt: Team tab
.. thumbnail:: /img/graphql/cloud/projects/collaborators-view.png
:alt: Collaborators tab
:width: 1146px
Team roles
^^^^^^^^^^
Collaborator roles
^^^^^^^^^^^^^^^^^^
Team members can have different levels of access in the Hasura console.
Collaborators can have different levels of access in the Hasura console.
- **Admin** has complete access to all project tools and configurations.
- **User** has limited privileges:

View File

@ -4,8 +4,8 @@
.. _manage_project_domains:
Domains tab
===========
Project Domains
===============
.. contents:: Table of contents
:backlinks: none

View File

@ -4,8 +4,8 @@
.. _manage_project_env_vars:
Env vars tab
============
Project Env vars
================
.. contents:: Table of contents
:backlinks: none

View File

@ -18,7 +18,7 @@ Introduction
Hasura cloud can keep your project's database URL i.e. the ``HASURA_GRAPHQL_DATABASE_URL`` env var in sync with Postgres from a Heroku app. This is especially helpful in cases when the database credentials of Heroku Postgres are rotated automatically by Heroku.
Enable Heroku database URL Sync
--------------------------------
-------------------------------
New Heroku database
^^^^^^^^^^^^^^^^^^^

View File

@ -4,8 +4,8 @@
.. _projects:
Projects & teams
================
Projects & collaborators
========================
.. contents:: Table of contents
:backlinks: none
@ -21,18 +21,24 @@ The ``Projects`` page show a list of your projects.
:alt: Projects list
:width: 1200px
For each project, you can:
- Click the gear icon to :ref:`manage your project <manage_project>`, or
- Click ``Launch Console`` to open the Hasura console in your browser, and navigate to the ``Pro`` tab to check out the Pro features that Hasura Cloud has set up for you.
For each project, you can do the one of the following actions:
.. thumbnail:: /img/graphql/cloud/getting-started/project-actions.png
:alt: Project actions
:width: 860px
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-overview.png
:alt: Hasura Console: Pro tab
:width: 1118px
- Click the gear icon to manage your project
.. thumbnail:: /img/graphql/cloud/projects/project-details.png
:alt: General tab
:width: 900px
- Click ``Launch Console`` to open the Hasura console in your browser. The ``Pro`` tab
lets you use the Pro features that Hasura Cloud has set up for you.
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-overview.png
:alt: Hasura Console: Pro tab
:width: 900px
.. note::
@ -46,7 +52,10 @@ Dig deeper
:titlesonly:
Creating projects <create>
Managing projects <manage-projects/index>
Project Collaborators <collaborators>
Project Env vars <env-vars>
Project Domains <domains>
Securing projects <secure>
Heroku database URL Sync <heroku-url-sync>
Deleting projects <delete>

View File

@ -1,31 +0,0 @@
.. meta::
:description: Managing projects on Hasura Cloud
:keywords: hasura, docs, project, general
.. _manage_project_general:
General tab
===========
.. contents:: Table of contents
:backlinks: none
:depth: 2
:local:
Introduction
------------
The ``General`` tab shows the project's general settings.
General settings
----------------
- **Name**: Unique auto-generated name for the project
- **ID**: Unique auto-generated ID for the project
- **GraphQL API**: GraphQL endpoint for the project
- **Admin Secret**: Secret for securing the GraphQL endpoint
- **Owner**: Email of the project owner
.. thumbnail:: /img/graphql/cloud/projects/project-details.png
:alt: General tab
:width: 1163px

View File

@ -1,37 +0,0 @@
.. meta::
:description: Managing projects on Hasura Cloud
:keywords: hasura, docs, project
.. _manage_project:
Managing projects
=================
.. contents:: Table of contents
:backlinks: none
:depth: 2
:local:
Introduction
------------
To view a project's details, and manage its teams and environment variables, navigate to the ``Projects`` page and click the gear icon on the project.
.. thumbnail:: /img/graphql/cloud/projects/manage-project.png
:alt: Manage project
:width: 865px
Managing projects
-----------------
See the below pages for detailed guides on managing projects:
.. toctree::
:maxdepth: 1
:titlesonly:
General tab <general>
Team tab <team>
Env vars tab <env-vars>
Heroku Database URL Sync <heroku>
Domains tab <domains>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB