-
Notifications
You must be signed in to change notification settings - Fork 366
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
Update docs with guides and tutorials for blueprint #5641
Merged
Merged
Changes from 9 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
d4961c6
Very WIP blueprint docs
jleibs d932e82
Rename to Configure the Viewer
jleibs 7cdb629
Update and fill in the API docs
jleibs e9701ad
title case
jleibs 315a488
Blueprint API tutorial
jleibs 88b5011
Fix picture tag
jleibs dd68710
refer to existing blueprint ref and update entity queries
jleibs 808bfa8
spell
jleibs b8cd88f
links
jleibs 0b73a11
tweaks
jleibs 28d6e53
Merge branch 'main' into jleibs/blueprint_docs
jleibs 3dcf3d6
remove conflicting blueprint doc page
jleibs 3b7a151
feedback from Niko
jleibs 816e9bd
link
jleibs 2233f29
skip tuxfamily
jleibs 6f44683
comment about tuxfamily links
jleibs File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: Configure the Viewer | ||
| order: 10 | ||
| --- | ||
|
|
||
| Although the Rerun Viewer tries to do a reasonable job of using heuristics to automatically determine | ||
| an appropriate layout given the data that you provide, there will always be situations where the heuristic | ||
| results don't match the needs of a particular use-case. | ||
|
|
||
| Fortunately, almost all aspects of the viewer can be configured via the [Blueprint](../reference/viewer/blueprint.md). | ||
|
|
||
| The viewer Blueprint completely determines: | ||
|
|
||
| - What contents are included in each view | ||
| - The type of view used to visualize the data | ||
| - The organizational layout and names of the different view panels and containers | ||
| - Configuration and styling properties of the individual data visualizers | ||
|
|
||
| There are a few different ways to work with Blueprints: | ||
|
|
||
| - [Blueprints can be modified directly through the UI](./configure-the-viewer/blueprint-ui.md) | ||
| - [Blueprint files (.rbl) can be saved and loaded from disk](./configure-the-viewer/rbl-files.md) | ||
| - [Blueprints can be generated direct from code](./configure-the-viewer/blueprint-apis.md) | ||
|
|
||
| For a hands on example, you can also follow the [Blueprint API Tutorial](./configure-the-viewer/blueprint-api-tutorial.md). | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Have we established anywhere that heuristics run to automatically to determine an appropriate layout? This feels like a non obvious concept to start with and if we don't cover it elsewhere, perhaps it should be introduced here and even needs a page under "Configure the viewer"?
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.
What would go on that page other than the same statement made here: "the Rerun Viewer tries to do a reasonable job of using heuristics to automatically determine an appropriate layout given the data that you provide "