Embed a video tutorial for Hubble

Open
#1,338 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Active
Tech stack
markdown
Domain
documentation

Research direction

Locate the Hubble (Data Analytics) documentation section and review the existing onboarding content, including the referenced Crash Course in Analytics presentation. Define or source 1–2 videos under five minutes covering the analyst quickstart and Hubble data model, then embed them in that section and verify they render correctly.

Written by the indexing model from the issue text.

Description

analytics bot:needs-author documentation
What problem does your feature solve?

Developers learn in different ways. Our current dev docs are text heavy. Video content is more engaging and may be a better onboarding experience. We would like to embed 1-2 video tutorials under the data analytics docs as an experiment.

What would you like to see?

1-2 videos embedded under Hubble (Data Analytics). We should focus on videos that explain more nuanced, complex concepts that may be missed with docs content alone.

  1. Hubble Quickstart (Analyst Perspective) - how to log in to BigQuery, write a query, explore metadata and query "gotchas". This can be very similar to the "Crash Course in Analytics" discord presentation. Maybe we link directly to that presentation?
  2. Hubble Data Model - walk through the different datasets, and explain the difference between the transactional and state tables

I think we should aim to keep the videos under 5 minutes. They should be quick and concise

What alternatives are there?
Dominant language
MDX
Stars
138
Forks
313
Avg merge
3d 11h
Merged PRs (30d)
44

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from stellar/stellar-docs

All issues in stellar/stellar-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.