diff --git a/datahub-cloud/Add sidebar navigation.md b/datahub-cloud/Add sidebar navigation.md new file mode 100644 index 0000000..5b163f7 --- /dev/null +++ b/datahub-cloud/Add sidebar navigation.md @@ -0,0 +1,21 @@ +--- +title: "Add sidebar navigation" +--- + +
+

A well-structured sidebar can significantly enhance the usability and navigability of your documentation or data site. With Datahub Cloud, you can easily implement sidebar navigation to help users quickly find and access the content they need. This section will guide you through the steps to add and customize a sidebar for your site.

+
+ +## Add sidebar navigation + +You can enable the sidebar by adding config.json file in the root of your site's repository (or its subfolder if you're publishing only this subfolder with DH Cloud) with the following content: + +``` +{ + "showSidebar": true +} +``` + +Here's how it should look like:" + +![[./assets/Screenshot3.png]] diff --git a/datahub-cloud/Add visuals and data-rich components.md b/datahub-cloud/Add visuals and data-rich components.md new file mode 100644 index 0000000..7484750 --- /dev/null +++ b/datahub-cloud/Add visuals and data-rich components.md @@ -0,0 +1,618 @@ +--- +title: "Add visuals and data-rich components" +--- + +
+

With Datahub Cloud, you can easily add various visual and data-rich components to your datasets or data stories, making them more engaging and insightful. This section will guide you through the process of incorporating charts, graphs, and other visual elements to bring your data to life.

+
+ +> [!info] Github is playing the role of your Editor. +> Any changes you want to make to your published site, you need to make in your GitHub repository first. +> Once you hit "sync" on your Site dashboard, the changes get reflected on your published site (unless you turn on the Auto-sync) + +You can check the full list and API of the available features here [https://storybook.portaljs.org](https://storybook.portaljs.org) + +# Table of Contents + +# Inserting a component + +1. Select the desired component you want to add from the sidebar list: + +![[./assets/Screenshot1.png]] + +2. Click on "Docs" +3. Hit "Show code" at the bottom right of the showcased feature + +![[./assets/Screenshot2.png]] + +6. Copy-paste the code into your markdown file in your GitHub repository +7. Commit the changes made +8. Navigate back to the App and hit "Sync" +9. Visit your site or refresh the page in order to see the reflected changes + +> [!info] To import a feature from URL, simply upload your data file to your Github repository and replace the URL in the copied code. Relative paths are supported. +> For concrete examples, please continue reading. + +## Different ways to insert a component + +Depending on the type of feature you selected from the list https://storybook.portaljs.org, you need to copy-paste the code block into your md file and: + +1) update the params _(refer to the params in the docs and their description)_ or +2) update the CSV link with the link of your data file (you can also use a relative path) or +3) update the URL to one of your own file and +4) Publish it with Datahub Cloud and share it with the world! + +# What features are supported? + +You can use several data preview and data visualization components to make your dataset more insightful. + +> [!hint] +> If the feature you need isn't on the list, ping us on [discord](https://discord.gg/KZSf3FG4EZ) or create an issue in the [datahub repository](https://github.com/datopian/datahub/issues) requesting it and we promise to look into it! + +## Catalog + +If your dataset is part of a larger dataset collection, you may want to start by listing the related datasets here in a catalog-like component with search and facets like this one: + + + +Simply copy and paste the following code snippet in the markdown file in your Github repository: + +``` + +``` + +Now update the values to reflect your datasets data (title, path) and the facet values relevant to your data. + +## Excel + +If you're working a lot with Excel files, you can embed a preview of your file such as this one: + + + +This component allows you to present all tabs in your Excel file. You can sort the rows by clicking on the Column name and you can also filter each column by clicking on the triple bar symbol next to the Column name. + +Simply copy and paste the following code snippet in the markdown file in your Github repository: + +``` + +``` + +Then upload your Excel file to your Github repository and replace the URL with the URL of the uploaded file (absolute and relative paths are supported). + +## Data Table + +Let's continue by adding a table of your data like the one below: + + + +Simply copy and paste the following code snippet in the markdown file in your Github repository: + +``` + +``` + + To get this data replaced with your data, upload your csv file to your repository and update the URL + +## Iframe + +If you're working with Microsoft Power BI reports or Google Lookerstudio or any similar, you can embed them within your page as follows: + +