Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Hubble Docs #167

Merged
merged 12 commits into from
Jun 30, 2023
Merged

Conversation

sydneynotthecity
Copy link
Contributor

Hubble does not have any public docs, and this update adds a new section under Docs called Accessing Historical Data. We focused on the following topics:

  • Overview - provide an overview of what Hubble is, how it differs from Horizon and when you should use it
  • Connecting - details 3 different connection methods to BigQuery (UI, SDKs and viz tool)
  • Viewing Metadata - shows end users how to discover information about Hubble through BigQuery Metadata

Future PRs will add more technical docs and examples, which we plan to put under APIs. This will include an entity relationship diagram, data dictionaries and detailed examples.

@stellar-jenkins
Copy link

@stellar-jenkins
Copy link

@briwylde08
Copy link
Contributor

The other sections of the docs typically have the Overview pulled out into its own section. Can we do that here for consistency? Example: https://developers.stellar.org/docs/anchoring-assets/overview

@sydneynotthecity
Copy link
Contributor Author

@briwylde08 done! thanks for the example. I had copied the format from the Horizon section, which is in the process of getting revamped.

@stellar-jenkins
Copy link

@stellar-jenkins
Copy link

1 similar comment
@stellar-jenkins
Copy link

@stellar-jenkins
Copy link

Copy link
Contributor

@Shaptic Shaptic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these are awesome 👏 left minor comments below, also maybe a chance to shoehorn the blogpost(s) into the docs somehow, maybe in the overview?

docs/accessing-data/overview.mdx Outdated Show resolved Hide resolved
docs/accessing-data/connecting.mdx Show resolved Hide resolved
docs/accessing-data/connecting.mdx Show resolved Hide resolved
docs/accessing-data/connecting.mdx Outdated Show resolved Hide resolved
docs/accessing-data/connecting.mdx Show resolved Hide resolved
docs/accessing-data/optimizing-queries.mdx Outdated Show resolved Hide resolved
- The database is updated in intraday batches. There is no guarantee for same-day data availability.
- The SDF hosts a public instance of Hubble, and end users incur the cost to execute queries. Visit the [BigQuery Pricing Page](https://cloud.google.com/bigquery/pricing#analysis_pricing_models) to learn more.

## Why We Chose BigQuery
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think worth providing one more section after this at bottom as brief summary of next steps, to guide the reader into 'how to use'

Next, using Hubble

  1. Data model
  2. Connecting
  3. Queries
  4. Optimizing
  5. ...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not suggesting more text, just links to the other existing pages, the sequence may provide 'getting started' for readers that want to proceed.

Copy link
Contributor

@sreuland sreuland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice work! will make note to link to the new overview from ongoing platform docs rewrite for partner experience

@stellar-jenkins
Copy link

@ElliotFriend
Copy link
Contributor

@sydneynotthecity I'm working on the PR concerning the restructure of the existing APIs here: #169 Jenkins is having some trouble with the preview at the moment, but I think once that's ironed out, it's pretty close to ready to go.

@stellar-jenkins
Copy link

@stellar-jenkins
Copy link

@stellar-jenkins
Copy link

@sydneynotthecity sydneynotthecity merged commit 7632d0a into stellar:main Jun 30, 2023
@sydneynotthecity sydneynotthecity deleted the add-hubble-docs branch June 30, 2023 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants