Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update paths #5665

Merged
merged 2 commits into from
Aug 25, 2020
Merged

docs: update paths #5665

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e7a920
update docs paths
rikinsk Aug 25, 2020
c82dfda
fix algolia index
rikinsk Aug 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Next Next commit
update docs paths
  • Loading branch information
@rikinsk
rikinsk committed Aug 25, 2020
commit 5e7a920b0c8b817e0a38a5434d5c27a64eae1a99
12 changes: 6 additions & 6 deletions docs/_theme/djangodocs/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
{% set is_landing_page = true %}
{%- endif %}

{%- if 'graphql/manual' in pagename %}
{%- if pagename.startswith('graphql/core') %}
{% set is_core = true %}
{%- elif 'cloud' in pagename %}
{%- elif pagename.startswith('graphql/cloud') %}
{% set is_cloud = true %}
{%- endif %}

Expand Down Expand Up @@ -111,7 +111,7 @@
</a>
</li>
<li>
<a href='https://hasura.io/docs/1.0/graphql/manual/getting-started/index.html'>
<a href='https://hasura.io/docs/1.0/graphql/core/getting-started/index.html'>
<button class="commonBtn navBtnHome">
Get Started
</button>
Expand Down Expand Up @@ -168,7 +168,7 @@
</a>
</li>
<li>
<a class="menuLink" href='https://hasura.io/docs/1.0/graphql/manual/getting-started/index.html'>
<a class="menuLink" href='https://hasura.io/docs/1.0/graphql/core/getting-started/index.html'>
<button class='commonBtn navBtnHome'>
Get Started
</button>
Expand All @@ -193,12 +193,12 @@
<img src="{{ pathto('_images/layout/close-icon.svg', 1) }}" alt="Close"/>
</div>
<div class="tabbarContainerWrapper blueBgColor boderBottom">
<a href="{{ pathto('graphql/manual/index.html', 1) }}" {%- if is_core %} class="tabbarTabActive" {%- endif %}>
<a href="{{ pathto('graphql/core/index.html', 1) }}" {%- if is_core %} class="tabbarTabActive" {%- endif %}>
<span>
Hasura Core
</span>
</a>
<a href="{{ pathto('cloud/index.html', 1) }}" {%- if is_cloud %} class="tabbarTabActive" {%- endif %}>
<a href="{{ pathto('graphql/cloud/index.html', 1) }}" {%- if is_cloud %} class="tabbarTabActive" {%- endif %}>
<span>
Hasura Cloud
</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/_theme/djangodocs/pages/landing.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ <h3 class="head_wrapper">Hasura docs</h3>
<p class="description">This guide covers all Hasura concepts and features.</p>
<ul>
<li>
<a class="docs_link" href="{{ pathto('graphql/manual/index.html', 1) }}">
<a class="docs_link" href="{{ pathto('graphql/core/index.html', 1) }}">
Core docs
</a>
</li>
<li>
<a class="docs_link" href="{{ pathto('cloud/index.html', 1) }}">
<a class="docs_link" href="{{ pathto('graphql/cloud/index.html', 1) }}">
Cloud docs
</a>
</li>
Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/allow-lists.rst → docs/graphql/cloud/allow-lists.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Manage the allow list

The manager view offers inspection, export, or removal of operations in the allow list:

.. thumbnail:: /img/cloud/security/pro-tabs-allowlist.png
.. thumbnail:: /img/graphql/cloud/security/pro-tabs-allowlist.png
:alt: Hasura Cloud Console allow list tab

Quick-create allowed operations
-------------------------------

This Pro feature lets you add to the allow list with one click from the record of past operations. (With Core, allow lists must be :ref:`managed manually <allow_list>`.)

.. thumbnail:: /img/cloud/security/allowlist-add-new-op.png
.. thumbnail:: /img/graphql/cloud/security/allowlist-add-new-op.png
:alt: Hasura Cloud Console create new allowed operation
4 changes: 2 additions & 2 deletions docs/cloud/api-limits.rst → docs/graphql/cloud/api-limits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Manage API limits

API limits can have a *global* or *per role* configuration. If an incoming request does not contain a valid role then the global limit is applied.

.. thumbnail:: /img/cloud/security/pro-tab-apilimits.png
.. thumbnail:: /img/graphql/cloud/security/pro-tab-apilimits.png
:alt: Hasura Cloud Console api limit tab

.. admonition:: Admin & IntrospectionQuery exemptions
Expand All @@ -45,5 +45,5 @@ Quick-create limits

Hasura Cloud lets you add limits with one click from the list of past operations.

.. thumbnail:: /img/cloud/security/pro-tab-apilimit-config.png
.. thumbnail:: /img/graphql/cloud/security/pro-tab-apilimit-config.png
:alt: Hasura Cloud Console create new api limit
0 docs/cloud/api-reference.rst → docs/graphql/cloud/api-reference.rst
View file
Open in desktop
File renamed without changes.
12 changes: 6 additions & 6 deletions docs/cloud/getting-started/index.rst → docs/graphql/cloud/getting-started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Step 2: Connect new/existing database
- To use an existing database, choose ``I have an existing Postgres database``.
- To create a new database, choose ``Try a free database with Heroku``.

.. thumbnail:: /img/cloud/getting-started/connect-db.png
.. thumbnail:: /img/graphql/cloud/getting-started/connect-db.png
:alt: Connect new or existing database
:width: 591px

Expand All @@ -35,7 +35,7 @@ Step 2a: Enter database URL (for existing database)

If you chose ``I have an existing Postgres database`` in :ref:`Step 2 <cloud_connect_db>`, enter a database URL.

.. thumbnail:: /img/cloud/getting-started/connect-existing-db.png
.. thumbnail:: /img/graphql/cloud/getting-started/connect-existing-db.png
:alt: Enter URL for existing database
:width: 556px

Expand All @@ -44,13 +44,13 @@ Step 3: Create project

Click ``Create Project``.

.. thumbnail:: /img/cloud/getting-started/create-project-new-db.png
.. thumbnail:: /img/graphql/cloud/getting-started/create-project-new-db.png
:alt: Create project for new database
:width: 539px
:group: create
:class: inline-block

.. thumbnail:: /img/cloud/getting-started/create-project-existing-db.png
.. thumbnail:: /img/graphql/cloud/getting-started/create-project-existing-db.png
:alt: Create project for existing database
:width: 552px
:group: create
Expand All @@ -66,7 +66,7 @@ Once you've created your project, you can get started with building with Hasura
:depth: 1
:local:

.. thumbnail:: /img/cloud/getting-started/project-functionalities.png
.. thumbnail:: /img/graphql/cloud/getting-started/project-functionalities.png
:alt: Project actions
:width: 860px

Expand All @@ -78,7 +78,7 @@ Click ``Launch Console`` to open the Hasura console in your browser and :ref:`ma

You can navigate to the ``Pro`` tab to check out the Pro features that Hasura Cloud has set up for you.

.. thumbnail:: /img/cloud/metrics/pro-tab-overview.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-overview.png
:alt: Hasura Console: Pro tab
:width: 1118px

Expand Down
0 docs/cloud/glossary.rst → docs/graphql/cloud/glossary.rst
View file
Open in desktop
File renamed without changes.
0 docs/cloud/hasurapro-cli/index.rst → docs/graphql/cloud/hasurapro-cli/index.rst
View file
Open in desktop
File renamed without changes.
0 docs/cloud/index.rst → docs/graphql/cloud/index.rst
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/cloud/metrics/errors.rst → docs/graphql/cloud/metrics/errors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Errors

Troubleshoot errors quickly with powerful analytical tools and filters:

.. thumbnail:: /img/cloud/metrics/pro-tab-errors.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-errors.png
:alt: Hasura Cloud Console errors tab

Drill into a specific operation via the magnifying-glass icon next to the operation summary in the 'Frequent errors' table. You'll be taken to a list of the failed operations, and can choose one to inspect the specific operation content, metadata, and error generated:

.. thumbnail:: /img/cloud/metrics/inspect-error.png
.. thumbnail:: /img/graphql/cloud/metrics/inspect-error.png
:alt: Hasura Cloud Console inspect a failed operation
2 changes: 1 addition & 1 deletion docs/cloud/metrics/index.rst → docs/graphql/cloud/metrics/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Introduction

Hasura Cloud projects include Pro features for enhanced reliability and performance

.. thumbnail:: /img/cloud/metrics/pro-tab-overview.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-overview.png
:alt: Hasura Cloud Console overview tab

Learn more
Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/metrics/operations.rst → docs/graphql/cloud/metrics/operations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ Operations

Processed realtime logs of all requests to the GraphQL Engine. View all and inspect individual operations:

.. thumbnail:: /img/cloud/metrics/pro-tab-operations.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-operations.png
:alt: Hasura Cloud Console list operations

.. thumbnail:: /img/cloud/metrics/pro-tab-operations-inspect.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-operations-inspect.png
:alt: Hasura Cloud Console inspect operation

Filtering operations
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/metrics/overview.rst → docs/graphql/cloud/metrics/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Overview

The Overview displays aggregate stats over the last hour:

.. thumbnail:: /img/cloud/metrics/pro-tab-overview.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-overview.png
:alt: Hasura Cloud Console overview tab
2 changes: 1 addition & 1 deletion docs/cloud/metrics/subscription-workers.rst → ...ql/cloud/metrics/subscription-workers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Subscription workers

Subscription workers offers a subscription-worker-specific version of usage statistics:

.. thumbnail:: /img/cloud/metrics/pro-tab-subscription-workers.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-subscription-workers.png
:alt: Hasura Cloud Console subscription workers tab
4 changes: 2 additions & 2 deletions docs/cloud/metrics/usage.rst → docs/graphql/cloud/metrics/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Usage

Learn about usage with aggregate summaries and filtering tools:

.. thumbnail:: /img/cloud/metrics/pro-tab-usage.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-usage.png
:alt: Hasura Cloud Console usage tab

Drill into an operation via its magnifying-glass icon in the 'Query List' table. You'll be taken to a list of similar operations, and can choose one to inspect for content, metadata, and error generated:

.. thumbnail:: /img/cloud/metrics/pro-tab-operations-inspect.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-operations-inspect.png
:alt: Hasura Cloud Console inspect an operation
2 changes: 1 addition & 1 deletion docs/cloud/metrics/websockets.rst → docs/graphql/cloud/metrics/websockets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Websockets

Websockets is a ws-specific version of usage statistics:

.. thumbnail:: /img/cloud/metrics/pro-tab-websockets.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-websockets.png
:alt: Hasura Cloud Console websockets tab
12 changes: 6 additions & 6 deletions docs/cloud/projects/create.rst → docs/graphql/cloud/projects/create.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can create a new Hasura Cloud project with either a new Postgres database, o

To begin, navigate to the ``Projects`` page, and click the ``New Project`` link.

.. thumbnail:: /img/cloud/projects/create-new-project.png
.. thumbnail:: /img/graphql/cloud/projects/create-new-project.png
:alt: create new project button
:width: 400

Expand All @@ -30,31 +30,31 @@ Hasura Cloud does not host databases, but does provide integrations with which y

To get started, click ``Try with Heroku``, and follow the prompts to authenticate with Heroku. Hasura Cloud will integrate with your Heroku account and manage the initial setup of a dev-tier Postgres instance. You can always upgrade the instance and manage options later through your Heroku account.

.. thumbnail:: /img/cloud/projects/create-project-heroku.png
.. thumbnail:: /img/graphql/cloud/projects/create-project-heroku.png
:alt: create new hosted project

Creating a project with an existing database
--------------------------------------------

To create a new Hasura Cloud project connected to an existing Postgres database, click ``Enter Database URL``, and enter your database connection string (looks like ``postgres://username:password@hostname:port/dbname``).

.. thumbnail:: /img/cloud/projects/new-project-hosted.png
.. thumbnail:: /img/graphql/cloud/projects/new-project-hosted.png
:alt: create new hosted project

Allowing connections from Hasura Cloud IP
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For some cloud services, like GCP, you'll need to adjust your Postgres connection settings to allow connections from the Hasura Cloud IP address. You can copy the IP address from either the copy icon in the ``Database Setup`` window, or the ``Hasura Cloud IP`` field on the project's details view. You may also need to disable SSL. Adding custom cert information to a Hasura Cloud instance is not yet available.

.. thumbnail:: /img/cloud/projects/existing-db-setup.png
.. thumbnail:: /img/graphql/cloud/projects/existing-db-setup.png
:alt: Existing database setup
:width: 568px

.. thumbnail:: /img/cloud/projects/hasura-cloud-ip.png
.. thumbnail:: /img/graphql/cloud/projects/hasura-cloud-ip.png
:alt: Hasura Cloud IP field
:width: 1200px

.. thumbnail:: /img/cloud/projects/gcp-postgres-authorized-network.png
.. thumbnail:: /img/graphql/cloud/projects/gcp-postgres-authorized-network.png
:alt: whitelist Hasura instance IP in Postgres settings
:width: 727px

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/projects/delete.rst → docs/graphql/cloud/projects/delete.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ Deleting projects

You can delete a project with the ``Delete Project`` button at the bottom of the project's details view.

.. thumbnail:: /img/cloud/projects/projects-delete.png
.. thumbnail:: /img/graphql/cloud/projects/projects-delete.png
:alt: delete a project
:width: 1199px
6 changes: 3 additions & 3 deletions docs/cloud/projects/index.rst → docs/graphql/cloud/projects/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Introduction

The ``Projects`` page show a list of your projects.

.. thumbnail:: /img/cloud/projects/projects-list.png
.. thumbnail:: /img/graphql/cloud/projects/projects-list.png
:alt: Projects list
:width: 1200px

Expand All @@ -26,11 +26,11 @@ 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.

.. thumbnail:: /img/cloud/getting-started/project-actions.png
.. thumbnail:: /img/graphql/cloud/getting-started/project-actions.png
:alt: Project actions
:width: 860px

.. thumbnail:: /img/cloud/metrics/pro-tab-overview.png
.. thumbnail:: /img/graphql/cloud/metrics/pro-tab-overview.png
:alt: Hasura Console: Pro tab
:width: 1118px

Expand Down
10 changes: 5 additions & 5 deletions ...loud/projects/manage-projects/domains.rst → ...loud/projects/manage-projects/domains.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Step 1: Navigate to add a custom domain

On the ``Domains`` tab, click on the ``New Custom Domain`` button.

.. thumbnail:: /img/cloud/projects/add-custom-domain.png
.. thumbnail:: /img/graphql/cloud/projects/add-custom-domain.png
:alt: Add custom domain
:width: 727px

Expand All @@ -36,7 +36,7 @@ Step 2: Add your custom domain

Enter your custom domain and click the ``Add`` button.

.. thumbnail:: /img/cloud/projects/choose-custom-domain.png
.. thumbnail:: /img/graphql/cloud/projects/choose-custom-domain.png
:alt: Choose custom domain
:width: 727px

Expand All @@ -45,15 +45,15 @@ Step 3: Add the record to your DNS

After adding a custom domain, the following window will show up:

.. thumbnail:: /img/cloud/projects/dns-settings.png
.. thumbnail:: /img/graphql/cloud/projects/dns-settings.png
:alt: DNS settings
:width: 727px

If you haven't already done so, add the default Hasura domain as a ``CNAME`` record to your DNS.

Until this is done, the dashboard will show a notice that the DNS validation is pending.

.. thumbnail:: /img/cloud/projects/dns-validation-pending.png
.. thumbnail:: /img/graphql/cloud/projects/dns-validation-pending.png
:alt: DNS validation pending
:width: 727px

Expand All @@ -66,6 +66,6 @@ DNS validated

Once the DNS is validated, the dashboard will update the status with the following notice:

.. thumbnail:: /img/cloud/projects/dns-validated.png
.. thumbnail:: /img/graphql/cloud/projects/dns-validated.png
:alt: DNS validated
:width: 727px
2 changes: 1 addition & 1 deletion ...oud/projects/manage-projects/env-vars.rst → ...oud/projects/manage-projects/env-vars.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ Adding an env var

Click on the ``New Env Var`` button and either choose an env var from the dropdown or add a custom env var.

.. thumbnail:: /img/cloud/projects/add-env-var.png
.. thumbnail:: /img/graphql/cloud/projects/add-env-var.png
:alt: add env var options
:width: 1200px
2 changes: 1 addition & 1 deletion ...loud/projects/manage-projects/general.rst → ...loud/projects/manage-projects/general.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ General settings
- **Admin Secret**: Secret for securing the GraphQL endpoint
- **Owner**: Email of the project owner

.. thumbnail:: /img/cloud/projects/project-details.png
.. thumbnail:: /img/graphql/cloud/projects/project-details.png
:alt: General tab
:width: 1163px
2 changes: 1 addition & 1 deletion .../cloud/projects/manage-projects/index.rst → .../cloud/projects/manage-projects/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ 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/cloud/projects/manage-project.png
.. thumbnail:: /img/graphql/cloud/projects/manage-project.png
:alt: Manage project
:width: 865px

Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/projects/manage-projects/team.rst → ...l/cloud/projects/manage-projects/team.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Add a collaborator

Click ``New Collaborator`` to invite a new team member.

.. thumbnail:: /img/cloud/projects/team-view.png
.. thumbnail:: /img/graphql/cloud/projects/team-view.png
:alt: Team tab
:width: 1146px

Expand All @@ -37,7 +37,7 @@ Team members can have different levels of access in the Hasura console.
- The ``Execute GraphQL`` permission allows running queries, mutations, and subscriptions.
- The ``View Metrics`` permission allows inspecting operation data and the performance dashboard.

.. thumbnail:: /img/cloud/projects/add-collaborator.png
.. thumbnail:: /img/graphql/cloud/projects/add-collaborator.png
:alt: Add collaborator
:width: 437px

Expand Down
Loading