docs: improve getting started

[DOCS-954]: https://hasurahq.atlassian.net/browse/DOCS-954?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9249
GitOrigin-RevId: e0230cb6406fa84062a40e2f18f100fa51459a05
This commit is contained in:
Rob Dominguez 2023-05-22 12:11:03 -05:00 committed by hasura-bot
parent e51d1cf936
commit c3a0b90033
11 changed files with 52 additions and 24 deletions

View File

@ -55,10 +55,13 @@ import Deployment from '@site/static/icons/features/deployment.svg';
## Deployment Topics ## Deployment Topics
<div className="overview-gallery"> <div className="overview-gallery">
<VersionedLink to="/getting-started/getting-started-cloud/"> <VersionedLink to="/getting-started/use-case/overview/">
<div className="card"> <div className="card">
<h3>Hasura Cloud</h3> <h3>Use Cases</h3>
<p>In just a couple of clicks, connect your existing data and have a production-ready GraphQL API.</p> <p>
No matter what you're looking to build, we have a set of use case guides that will walk you through the setup,
step-by-step.
</p>
</div> </div>
</VersionedLink> </VersionedLink>
<VersionedLink to="/deployment/deployment-guides/index/"> <VersionedLink to="/deployment/deployment-guides/index/">

View File

@ -63,17 +63,19 @@ gives you the time to migrate over any legacy code or rewrite existing microserv
## How can I get Hasura up-and-running quickly? ## How can I get Hasura up-and-running quickly?
The easiest and fastest way to get Hasura up and running quickly is by using our The easiest and fastest way to get Hasura up and running quickly is by using our
[Hasura Cloud](/getting-started/getting-started-cloud.mdx) platform. Hasura can be also deployed easily in a [Hasura Cloud](/getting-started/getting-started-cloud.mdx) platform. We have a set of
[Docker container](/getting-started/docker-simple.mdx). [sample use cases](/getting-started/use-case/overview.mdx) available with step-by-step instructions in place.
Hasura can be also deployed easily in a [Docker container](/getting-started/docker-simple.mdx).
## What does my first-time demo experience look like? ## What does my first-time demo experience look like?
Using the Hasura Console, click on the Data tab and connect up a new Postgres database from our partner company Using the Hasura Console, click on the Data tab and connect up a new Postgres database from our partner company
[Neon](/databases/postgres/neon.mdx). Then create tables, insert some demo data and test out some [Neon](/databases/postgres/neon.mdx). Then create tables, insert some demo data and test out some queries and mutations
queries and mutations using the GraphiQL interface in the API tab. Alternatively, from your connected database in the using the GraphiQL interface in the API tab. Alternatively, from your connected database in the Data tab, try one of our
Data tab, try one of our demo templates from the Template Gallery which can demonstrate key Hasura features for you demo templates from the Template Gallery which can demonstrate key Hasura features for you quickly. If you already have
quickly. If you already have an existing database with tables and data you can also just have Hasura connect to it, an existing database with tables and data you can also just have Hasura connect to it, track tables and relationships,
track tables and relationships, and you can immediately start exploring your new GraphQL API. and you can immediately start exploring your new GraphQL API.
## What's so great about GraphQL? ## What's so great about GraphQL?

View File

@ -45,6 +45,16 @@ docker compose up -d
## Step 2: Connect a database ## Step 2: Connect a database
:::info Hasura ships with a Postgres database
The docker-compose file we used in the previous step starts a Postgres database in a Docker container. **Hasura relies
on this database to store its metadata**, but this can also be used to store your application data.
If you'd like to connect another type of database for storing application data, check out our list of
[supported databases](/databases/overview.mdx).
:::
Open the Hasura Console by navigating to `http://localhost:8080/console`. From the Console, click the `Data` tab: Open the Hasura Console by navigating to `http://localhost:8080/console`. From the Console, click the `Data` tab:
<Thumbnail src="/img/getting-started/connect-db-console.png" alt="Connect database" width="1000px" /> <Thumbnail src="/img/getting-started/connect-db-console.png" alt="Connect database" width="1000px" />
@ -90,7 +100,8 @@ You'll see that you get all the inserted data!
<Thumbnail src="/img/getting-started/profile-query.png" alt="Try out a query" width="1200px" /> <Thumbnail src="/img/getting-started/profile-query.png" alt="Try out a query" width="1200px" />
> Note: The Hasura GraphQL Engine collects anonymous telemetry to understand usage and provide the best experience. Read more [here](https://hasura.io/docs/latest/policies/telemetry/) on what data is collected and the procedure to opt out. > Note: The Hasura GraphQL Engine collects anonymous telemetry to understand usage and provide the best experience. Read
> more [here](https://hasura.io/docs/latest/policies/telemetry/) on what data is collected and the procedure to opt out.
## Recap ## Recap

View File

@ -21,7 +21,19 @@ import ProductBadge from '@site/src/components/ProductBadge';
## Introduction ## Introduction
This guide talks about setting up Hasura Cloud with a new or existing database. Hasura Cloud is a powerful tool that can work with a wide variety of databases. If you have a preferred database, check
out our [supported databases](/databases/overview.mdx) for details on how to connect.
If you're just getting started with Hasura, you can also try out our free Neon Postgres database. We'll walk you through
the setup process in this guide, so you can get started quickly and easily.
:::info Not sure what you want to build?!
If you're not sure what you want to build with Hasura, check out our
[sample use cases](/getting-started/use-case/overview.mdx) for inspiration, and we'll walk you through the setup
step-by-step!
:::
## Step 1: Create an account ## Step 1: Create an account
@ -64,7 +76,7 @@ Hit the `Launch console` button to open the Hasura Console and navigate to `Data
<Thumbnail src="/img/getting-started/connect-db-console.png" alt="Connect database" width="1000px" /> <Thumbnail src="/img/getting-started/connect-db-console.png" alt="Connect database" width="1000px" />
- To try out quickly with a new Postgres database, choose `Create New Database`. - To try out quickly with a new Postgres database, choose `Create New Database`.
- To use an existing database, choose `Connect existing database`. - To use an [existing database](/databases/overview.mdx), choose `Connect existing database`.
<Thumbnail src="/img/getting-started/db-setup.png" alt="DB setup" width="1000px" /> <Thumbnail src="/img/getting-started/db-setup.png" alt="DB setup" width="1000px" />

View File

@ -30,7 +30,7 @@ import Basics from '@site/static/icons/features/basics.svg';
<h4>Quick Links</h4> <h4>Quick Links</h4>
<ul> <ul>
<li> <li>
<VersionedLink to="/getting-started/getting-started-cloud">Get started using Hasura Cloud.</VersionedLink> <VersionedLink to="/getting-started/use-case/overview/">Get started using Hasura Cloud with one of our use case guides.</VersionedLink>
</li> </li>
<li> <li>
Get started using <VersionedLink to="/getting-started/docker-simple">Docker</VersionedLink> or check out one of our <VersionedLink to="/deployment/deployment-guides/index">deployment guides.</VersionedLink> Get started using <VersionedLink to="/getting-started/docker-simple">Docker</VersionedLink> or check out one of our <VersionedLink to="/deployment/deployment-guides/index">deployment guides.</VersionedLink>

View File

@ -0,0 +1,7 @@
{
"label": "Hasura Use Cases",
"position": 4,
"customProps": {
"sidebar_pathname": "getting-started/use-case"
}
}

View File

@ -29,20 +29,20 @@ learning about diverse applications that demonstrate the true potential of the H
## Build a GraphQL backend ## Build a GraphQL backend
Construct a complex data model with a permission layer and expose it over a GraphQL endpoint for your backend service. Construct a complex data model with a permission layer and expose it over a GraphQL endpoint for your backend service.
[Learn more](/resources/use-case/gql-backend.mdx) [Learn more](/getting-started/use-case/gql-backend.mdx)
<Thumbnail src="/img/use-case-overview/gql-backend.svg" alt="Hasura GraphQL Backend overview" width="600px" /> <Thumbnail src="/img/use-case-overview/gql-backend.svg" alt="Hasura GraphQL Backend overview" width="600px" />
## Build a Data Access Layer ## Build a Data Access Layer
Effortlessly expose an authorization-enabled GraphQL service on top of your data sources in a matter of minutes. Effortlessly expose an authorization-enabled GraphQL service on top of your data sources in a matter of minutes.
[Learn more](/resources/use-case/data-api.mdx) [Learn more](/getting-started/use-case/data-api.mdx)
<Thumbnail src="/img/use-case-overview/data-api.svg" alt="Hasura Data API overview" width="600px" /> <Thumbnail src="/img/use-case-overview/data-api.svg" alt="Hasura Data API overview" width="600px" />
## Build an API gateway ## Build an API gateway
Implement Hasura as a single gateway instance for your user clients, providing a streamlined interface to downstream Implement Hasura as a single gateway instance for your user clients, providing a streamlined interface to downstream
microservices. [Learn more](/resources/use-case/api-gateway.mdx) microservices. [Learn more](/getting-started/use-case/api-gateway.mdx)
<Thumbnail src="/img/use-case-overview/api-gateway.svg" alt="Hasura API Gateway overview" width="600px" /> <Thumbnail src="/img/use-case-overview/api-gateway.svg" alt="Hasura API Gateway overview" width="600px" />

View File

@ -1,7 +0,0 @@
{
"label": "Hasura Use Cases",
"position": 1,
"customProps": {
"sidebar_pathname": "resources/use-case"
}
}