-
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
Render demo manifest #3151
Render demo manifest #3151
Conversation
@@ -218,7 +308,7 @@ def main() -> None: | |||
BASE_PATH = "web_demo" | |||
SCRIPT_PATH = os.path.dirname(os.path.relpath(__file__)) | |||
# When adding examples, add their requirements to `requirements-web-demo.txt` | |||
EXAMPLES = { | |||
EXAMPLES: dict[str, Any] = { |
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.
@abey79
We didn't specify this, but I assume you wanted the examples which are on demo.rerun.io
, because those are the only ones which have .rrd
files built on CI. If that's the case, the dna
example needs a README + thumbnail - how did we make those again?
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.
I'm thinking that it's maybe more future-proof to include everything in the manifest. Then, in the UI, we can pull only those example which have a RRD url specified.
As for the DNA example, I guess we just need to add a README.md
with front matter in examples/python/dna/
? It looks like an oversight that there isn't one already.
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.
I'm thinking that it's maybe more future-proof to include everything in the manifest
That's not a difficult change to make (we fetch all the data from README files instead of hardcoding a map like this), so I'd rather only do the minimum required work here.
As for the DNA example, I guess we just need to add a README.md with front matter in examples/python/dna/?
Yes, but that requires taking a screenshot which I haven't done before, do you remember where the instructions are for that?
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.
The script doesnt assume that the readme exists, so its safe to add it 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.
Taking a screenshot is ctrl-P
for the command palette -> screenshot. For the upload, just upload --help
. Since the screenshot feature copies to clipboard, the easiest is just upload --name example_name
(the script pulls from clipboard if no input path is provided).
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.
Looks good!
What
Closes #3105
Checklist