-
Notifications
You must be signed in to change notification settings - Fork 373
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
Generate doc pages for blueprint views #6121
Merged
Merged
Conversation
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
Deployed docs
|
jleibs
added
📖 documentation
Improvements or additions to documentation
🟦 blueprint
The data that defines our UI
include in changelog
labels
Apr 25, 2024
@jprochazk I could use a hand understanding why this broke the doc preview. |
You didn't, it's broken on |
Broken since #5966 🤔 |
Wumpf
approved these changes
Apr 26, 2024
(tentative approval, we have to fix the preview) |
Preview is fixed by rebasing |
oops. how did that happen, just wanted to merge main. fixing. |
Wumpf
force-pushed
the
jleibs/blueprint_doc_codegen
branch
from
April 26, 2024 12:49
23b01df
to
9957d7d
Compare
didn't notice that this pr is targeting another branch. that's why. undid my merge |
jleibs
force-pushed
the
jleibs/blueprint_doc_codegen
branch
from
April 26, 2024 13:55
9957d7d
to
ba23873
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
🟦 blueprint
The data that defines our UI
📖 documentation
Improvements or additions to documentation
include in changelog
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.
What
do-no-merge
label.Add blueprint views to the python docs index.
Create a reference page for each view with documentation of its view properties and an example when provided.
Generating pages for all the blueprint archetypes and cross-linking still felt a bit overwhelming. Since these properties are almost always only used in the context of the view, I decided to inline instead.
Checklist
main
build: rerun.io/viewernightly
build: rerun.io/viewerTo run all checks from
main
, comment on the PR with@rerun-bot full-check
.