From 3eb8e616ca73fda903cc87e892fb5819a577b68f Mon Sep 17 00:00:00 2001 From: Aseem Bansal Date: Thu, 16 Mar 2023 12:26:10 +0530 Subject: [PATCH] docs: misc fixes (#7603) --- docs-website/sidebars.js | 1 + docs/cli.md | 2 +- docs/debugging.md | 6 ++++-- docs/faq-using-datahub.md | 7 +++++++ 4 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 docs/faq-using-datahub.md diff --git a/docs-website/sidebars.js b/docs-website/sidebars.js index 296188f6fe..b9ddb101e7 100644 --- a/docs-website/sidebars.js +++ b/docs-website/sidebars.js @@ -462,6 +462,7 @@ module.exports = { ], }, "docs/debugging", + "docs/faq-using-datahub", "docs/plugins", { diff --git a/docs/cli.md b/docs/cli.md index deff3d4273..8036663b80 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -86,7 +86,7 @@ Running `datahub init` will allow you to customize the datahub instance you are **_Note_**: Provide your GMS instance's host when the prompt asks you for the DataHub host. -#### Environment variables supported +### Environment variables supported The environment variables listed below take precedence over the DataHub CLI config created through the `init` command. diff --git a/docs/debugging.md b/docs/debugging.md index 5396423ce1..16e29c3b6b 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -1,4 +1,6 @@ -# Debugging Guide +# Quickstart Debugging Guide + +For when [Quickstart](./quickstart.md) did not work out smoothly. ## How can I confirm if all Docker containers are running as expected after a quickstart? @@ -146,7 +148,7 @@ docker exec -i mysql sh -c 'exec mysql datahub -udatahub -pdatahub' < docker/mys ## I've messed up my docker setup. How do I start from scratch? Run the following script to remove all the containers and volumes created during the quickstart tutorial. Note that you'll also lose all the data as a result. ``` -./docker/nuke.sh +datahub docker nuke ``` ## I'm seeing exceptions in DataHub GMS container like "Caused by: java.lang.IllegalStateException: Duplicate key com.linkedin.metadata.entity.ebean.EbeanAspectV2@dd26e011". What do I do? diff --git a/docs/faq-using-datahub.md b/docs/faq-using-datahub.md new file mode 100644 index 0000000000..b7d29b5b03 --- /dev/null +++ b/docs/faq-using-datahub.md @@ -0,0 +1,7 @@ +# FAQ Using DataHub + +## Logo for my platform is not appearing on the Home Page or search results + +Please see if either of these guides help you +- [Adding a custom Dataset Data Platform](./how/add-custom-data-platform.md) +- [DataHub CLI put platform command](./cli.md#put-platform) \ No newline at end of file