-
Notifications
You must be signed in to change notification settings - Fork 128
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
Add Hubble Docs #167
Conversation
Preview is available here: |
Preview is available here: |
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 |
@briwylde08 done! thanks for the example. I had copied the format from the Horizon section, which is in the process of getting revamped. |
Preview is available here: |
Preview is available here: |
1 similar comment
Preview is available here: |
Preview is available here: |
There was a problem hiding this 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?
- 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 |
There was a problem hiding this comment.
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
- Data model
- Connecting
- Queries
- Optimizing
- ...
There was a problem hiding this comment.
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.
There was a problem hiding this 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
Preview is available here: |
@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. |
Preview is available here: |
Preview is available here: |
Preview is available here: |
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: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.