From 3136ad865f003d07f19583c2e68c242875d3411e Mon Sep 17 00:00:00 2001 From: Maggie Hays Date: Wed, 26 Oct 2022 18:29:11 -0500 Subject: [PATCH] docs(getting started): update Getting Started landing page (#6282) --- docs-website/sidebars.js | 2 +- .../docs/_components/QuickLinkCards/index.js | 2 +- docs/get-started-with-datahub.md | 63 +++++++++++++++++++ docs/wip/get-started.md | 5 -- 4 files changed, 65 insertions(+), 7 deletions(-) create mode 100644 docs/get-started-with-datahub.md delete mode 100644 docs/wip/get-started.md diff --git a/docs-website/sidebars.js b/docs-website/sidebars.js index 0bc05a73fe..e1e15f58e1 100644 --- a/docs-website/sidebars.js +++ b/docs-website/sidebars.js @@ -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", diff --git a/docs-website/src/pages/docs/_components/QuickLinkCards/index.js b/docs-website/src/pages/docs/_components/QuickLinkCards/index.js index ca450cd291..caf49e856c 100644 --- a/docs-website/src/pages/docs/_components/QuickLinkCards/index.js +++ b/docs-website/src/pages/docs/_components/QuickLinkCards/index.js @@ -20,7 +20,7 @@ const quickLinkContent = [ title: "Get Started", icon: , description: "Details on how to get DataHub up and running", - to: "/docs/quickstart", + to: "/docs/get-started-with-datahub", }, { title: "Ingest Metadata", diff --git a/docs/get-started-with-datahub.md b/docs/get-started-with-datahub.md new file mode 100644 index 0000000000..6d3af2dc5c --- /dev/null +++ b/docs/get-started-with-datahub.md @@ -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. + +::: + +

+ + Get Started with Self-Hosted DataHub + +

+ +## 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://.acryl.io` +* Admin account credentials for logging into the DataHub UI + +

+ + Get Started with Managed DataHub + +

diff --git a/docs/wip/get-started.md b/docs/wip/get-started.md deleted file mode 100644 index b57cd380a8..0000000000 --- a/docs/wip/get-started.md +++ /dev/null @@ -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). \ No newline at end of file