DataHub 101 - Getting Familiar with DataHub Docs

00:07:32
https://www.youtube.com/watch?v=UDaSJSJI1rg

Summary

TLDRThe video guides users through the AEL documentation site, showcasing its structure and key features. It highlights how to access various resources, including integration sources and community areas, and explains the functionality of the AI board for quick help. Users learn about the sidebar categories ranging from getting started to advanced API guides and how to contribute to the documentation through GitHub. The emphasis is on user engagement and utilizing the available tools effectively.

Takeaways

  • 📝 The doc site is structured with tabs for easy navigation.
  • 🔍 Use the search function to find integration sources quickly.
  • 🤖 The AI board can answer questions about the docs.
  • 📂 Filter data sources by type and features to find what you need.
  • 📢 Community resources will be available soon.
  • 🚀 Getting started and deployment guides are available for new users.
  • 📄 Contributions can be made by reporting issues or suggesting edits.
  • 🧩 Resources for advanced API and SDK functionalities are provided.

Timeline

  • 00:00:00 - 00:07:32

    Hun introduces the AEL documentation site, emphasizing navigation and key resources available under various tabs such as Docs, Integrations, and Community. The Docs tab contains essential guides, tutorials, and features, whereas the Integrations tab allows users to search for supported data sources like MongoDB. Hun briefly mentions upcoming updates for the Community tab and resources available like a demo site, blog, and a roadmap.

Mind Map

Video Q&A

  • What is the purpose of the AEL doc site?

    The AEL doc site is designed to provide users with information, guides, tutorials, and resources related to the data hop project.

  • How can I find specific integration sources?

    You can search for specific integration sources using the search bar in the Integrations tab.

  • What tools are mentioned in the doc site?

    Useful tools include an AI board for FAQs and a version selector for different documentation versions.

  • How can I contribute to the docs?

    You can contribute by clicking 'edit this page', which leads you to the GitHub repo to make changes or suggestions.

  • Where can I find community resources?

    Community resources are located under the Resources tab, including a community Slack channel.

  • Is there a way to filter data sources?

    Yes, you can filter data sources by connection type, features, and platform type.

  • What types of guides are available?

    Guides include getting started, deployment, admin, API, and SDK resources.

  • What should I do if I find a mistake in the documentation?

    You can report it by suggesting a fix through the 'edit this page' link.

View more video summaries

Get instant access to free YouTube video summaries powered by AI!
Subtitles
en
Auto Scroll:
  • 00:00:01
    hey guys I'm hun from the team in AEL
  • 00:00:04
    I'm here to guide you through our do
  • 00:00:06
    site today we'll dive into where to find
  • 00:00:08
    the right information highlight some
  • 00:00:10
    useful tools in our doc site and discuss
  • 00:00:13
    how to contribute to docks so when you
  • 00:00:16
    go to our doc site data hop
  • 00:00:20
    project. you'll notice that we have a
  • 00:00:22
    few tabs on the top right do
  • 00:00:24
    Integrations Community Resources note
  • 00:00:27
    that the community tab is not released
  • 00:00:29
    yet it's included in the upcoming change
  • 00:00:32
    and most of our of our contents lies
  • 00:00:34
    under the docs tab so everything um
  • 00:00:38
    around the guides tutorial our key
  • 00:00:41
    features API guides release stories are
  • 00:00:44
    here and under Integrations this is a
  • 00:00:47
    place where you can search um our
  • 00:00:51
    integration sources so let's say you
  • 00:00:53
    want to know if data hop um supports
  • 00:00:57
    mongod DB as a integration source you
  • 00:01:00
    can just search its name here and if you
  • 00:01:03
    click the card it will navigate you to
  • 00:01:06
    the corresponding guide in our doc site
  • 00:01:09
    and um you can also use the filters to
  • 00:01:13
    search the data sources you can search
  • 00:01:17
    it by the connection type the features
  • 00:01:19
    whether it supports column level Lage um
  • 00:01:22
    staple ingestion and also platform type
  • 00:01:26
    such as data store bi tool messaging
  • 00:01:30
    um yeah so let's say you want to um know
  • 00:01:35
    which data sources support push based
  • 00:01:38
    ingestion you can just um click push
  • 00:01:41
    here and his search and every data
  • 00:01:44
    sources that supports push based ntion
  • 00:01:47
    will show up
  • 00:01:49
    here yeah and under Community um under
  • 00:01:52
    resources um this is a place that um all
  • 00:01:55
    the materials that will help you
  • 00:01:57
    understand data H will go so you can
  • 00:02:00
    visit our demo site your our blog our
  • 00:02:03
    road map our gtop
  • 00:02:05
    Etc and under Community this is um going
  • 00:02:09
    to release soon but I'm going to do a
  • 00:02:11
    sneak peek here so you can um visit our
  • 00:02:15
    slack Community through here or you can
  • 00:02:18
    see our Hall of Fame of our dat of
  • 00:02:21
    Champions so keep an eye for the update
  • 00:02:25
    in our slack
  • 00:02:26
    Community yeah and let's get back to our
  • 00:02:30
    docs so let's dive into the sideb bar a
  • 00:02:34
    little bit so on the top level we have
  • 00:02:37
    getting started Integrations deployment
  • 00:02:40
    ad me developers API and sdks and
  • 00:02:44
    community so all the things
  • 00:02:47
    from um the getting started
  • 00:02:50
    to deployment goes to the day one
  • 00:02:53
    material so let's say it's your first
  • 00:02:56
    time with data Hub you want to
  • 00:02:58
    understand um what the key features are
  • 00:03:01
    or you want to deploy it um as a POC you
  • 00:03:05
    want to maybe quickly connect your data
  • 00:03:09
    sources everything um relate to that is
  • 00:03:12
    here so for example we have a key key
  • 00:03:15
    feature guide here and a basic guide on
  • 00:03:18
    how to get started we have a quick start
  • 00:03:20
    guide that lets you deploy data Hub
  • 00:03:23
    within a few steps and we also have some
  • 00:03:27
    kickart guides on our um
  • 00:03:30
    some popular data sources such as rest
  • 00:03:34
    shift or Tavo or
  • 00:03:37
    Snowflake and we also have a deployment
  • 00:03:40
    guide for um different platforms such as
  • 00:03:44
    AWS GP and
  • 00:03:47
    Azure yeah and all the things from admin
  • 00:03:50
    to API and SDK belongs
  • 00:03:54
    to um the T day two material in my
  • 00:03:58
    perspective so let's say you already
  • 00:04:01
    deploy data Hub somewhere um whether
  • 00:04:03
    it's say it's in your local machine or
  • 00:04:06
    somewhere in the cloud and you want to
  • 00:04:09
    maybe invite some users um maybe you
  • 00:04:12
    want to customize the data of instance
  • 00:04:15
    or you want to utilize one of our apis
  • 00:04:17
    all the guys relate to that here so we
  • 00:04:21
    have our alt guid we have um guys to um
  • 00:04:26
    guys own the local development of data
  • 00:04:28
    Hub and and all the GU to related to our
  • 00:04:33
    apis sdks um graphql CLI actions are
  • 00:04:38
    here last but not least we have um um
  • 00:04:42
    under Community tab we have all the
  • 00:04:45
    community um dos here and also you can
  • 00:04:48
    see the release history of our product
  • 00:04:51
    as
  • 00:04:52
    well and now I'm going to um introduce
  • 00:04:57
    some useful tools in our do site so
  • 00:04:59
    first you can see this little blue
  • 00:05:01
    widget on the right bottom on every page
  • 00:05:03
    this is an AI board for our doc site so
  • 00:05:07
    this will answer PR pretty much
  • 00:05:10
    everything that is on our docks let's
  • 00:05:12
    say you want to know how to enable
  • 00:05:15
    column level lineage in big three so you
  • 00:05:18
    can just um
  • 00:05:21
    type how to enable
  • 00:05:25
    column level Lish on B Curry and the
  • 00:05:30
    board will find the relevant page on our
  • 00:05:32
    doc site and provide um answer for
  • 00:05:39
    you yeah so you can see that the B
  • 00:05:42
    actually found some
  • 00:05:49
    um yeah found some related um materials
  • 00:05:52
    on the do side and provid the answer for
  • 00:05:55
    you and another thing is versioning so
  • 00:06:00
    you'll notice that we have a version SE
  • 00:06:01
    selector on the top left and you can
  • 00:06:06
    select the version for the open source
  • 00:06:08
    data Hub you can actually move across
  • 00:06:10
    the versions to find the docs that
  • 00:06:12
    corresponds to your
  • 00:06:15
    version yeah last but not least let's
  • 00:06:18
    talk about how to contribute to our do
  • 00:06:20
    site so there's no limit where and what
  • 00:06:24
    you can contribute to our docks if you
  • 00:06:26
    spot a typo or you want to suggest a fix
  • 00:06:30
    or if you think some of the contents are
  • 00:06:32
    missing um you can also contribute as
  • 00:06:34
    well and the fastest way to
  • 00:06:38
    contribute is just to click um say just
  • 00:06:43
    to click this edit this page link on
  • 00:06:46
    every bottom every on the bottom of
  • 00:06:48
    every page and this will directly
  • 00:06:51
    navigate you to the corresponding
  • 00:06:53
    markdown file on our GitHub repo so you
  • 00:06:56
    can start there or you can um just clone
  • 00:07:00
    our um clone our get repo and start from
  • 00:07:05
    there as well or if you're not sure how
  • 00:07:08
    to create a PR or handle the G repo you
  • 00:07:11
    can post a message on our slot Community
  • 00:07:14
    um specifically we have a channel called
  • 00:07:16
    code contribute um where we talk about
  • 00:07:19
    all the contribution stuff and our team
  • 00:07:22
    will gladly help
  • 00:07:24
    you uh so that was a quick guide on our
  • 00:07:27
    doc site hope this was helpful full see
  • 00:07:31
    you
Tags
  • documentation
  • AEL
  • data hop
  • guides
  • community
  • integration
  • AI tools
  • contribution
  • resources
  • deployment