docs(getting started): update Getting Started landing page (#6282)

This commit is contained in:
Maggie Hays 2022-10-26 18:29:11 -05:00 committed by GitHub
parent dc1e4d70e4
commit 3136ad865f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 65 additions and 7 deletions

View File

@ -64,7 +64,7 @@ module.exports = {
// - Create Polices & assign roles
// - Ingest at least one source (ie. data warehouse)
// - Understand high-level options for enriching metadata
"docs/wip/get-started",
"docs/get-started-with-datahub",
{
"Self-Hosted DataHub": [
"docs/quickstart",

View File

@ -20,7 +20,7 @@ const quickLinkContent = [
title: "Get Started",
icon: <ThunderboltTwoTone />,
description: "Details on how to get DataHub up and running",
to: "/docs/quickstart",
to: "/docs/get-started-with-datahub",
},
{
title: "Ingest Metadata",

View File

@ -0,0 +1,63 @@
# Get Started With DataHub
This section is focused on helping you get up and running with DataHub as quickly as possible.
## Get Started with Self-Hosted DataHub
This is a great place to start if you're new to DataHub and are interested in taking the open-source project for a spin.
You'll learn how to:
* Deploy DataHub on your local machine
* Ingest sample data to get a feel for what is possible in DataHub
* Add and invite users to DataHub
* Troubleshoot common issues
### Prerequisites
Before you go further, ensure you have the following installed:
* [Python >=3.7.0](https://www.python.org/downloads/)
* [Docker](https://docs.docker.com/get-docker/)
* [jq](https://stedolan.github.io/jq/download/)
* [Docker Compose](https://github.com/docker/compose/blob/master/INSTALL.md) - if using Linux
:::note
Make sure to allocate enough hardware resources for Docker!
We recommend the following configuration: 2 CPUs, 8GB RAM, 2GB Swap area, and 10GB disk space.
:::
<p>
<a
className='button button--primary button--lg'
href="quickstart">
Get Started with Self-Hosted DataHub
</a>
</p>
## Get Started with Managed DataHub
[Acryl Data](https://www.acryldata.io/product) provides a fully managed, premium version of DataHub.
In this section, you'll learn how to:
* Add and invite users to DataHub
* Configure Slack notifications
* Understand Approval Workflows
### Prerequisites
Before you go further, you'll need to have a DataHub instance provisioned. The Acryl Integrations Team will provide you with the following once it has been deployed:
* The URL for your Acryl instance, i.e. `https://<your-domain-name>.acryl.io`
* Admin account credentials for logging into the DataHub UI
<p>
<a
className='button button--primary button--lg'
href="authentication/guides/add-users">
Get Started with Managed DataHub
</a>
</p>

View File

@ -1,5 +0,0 @@
# Get Started With DataHub
To get started with running the open-source DataHub locally on your system (a.k.a Self-Hosted DataHub), head over to the [QuickStart section](../quickstart.md).
To get started with the [Acryl Data](https://acryldata.io) provided SaaS instance of DataHub (a.k.a Managed DataHub), head over to the [Managed DataHub section](../managed-datahub/saas-slack-setup.md).