Skip to content

Commit

Permalink
docs(getting started): update Getting Started landing page (datahub-p…
Browse files Browse the repository at this point in the history
  • Loading branch information
maggiehays authored Oct 26, 2022
1 parent dc1e4d7 commit 3136ad8
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs-website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
63 changes: 63 additions & 0 deletions docs/get-started-with-datahub.md
Original file line number Diff line number Diff line change
@@ -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>
5 changes: 0 additions & 5 deletions docs/wip/get-started.md

This file was deleted.

0 comments on commit 3136ad8

Please sign in to comment.