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

Generate JSON with example metadata #3105

Closed
Tracked by #3096
abey79 opened this issue Aug 25, 2023 · 0 comments · Fixed by #3151
Closed
Tracked by #3096

Generate JSON with example metadata #3105

abey79 opened this issue Aug 25, 2023 · 0 comments · Fixed by #3151
Assignees
Labels
examples Issues relating to the Rerun examples

Comments

@abey79
Copy link
Member

abey79 commented Aug 25, 2023

The "example build system" should produce a JSON containing all example metadata, including:

  • name
  • description
  • tags
  • URL of the example web page
  • URL of the thumbnail
  • ideally, pixel size of the thumbnail (so we can layout the GUI before the thumbnail is actually downloaded)
  • URL of the RRD (if any)

This will be used to build the in-viewer example list

@abey79 abey79 added the examples Issues relating to the Rerun examples label Aug 25, 2023
@jprochazk jprochazk mentioned this issue Aug 30, 2023
3 tasks
jprochazk added a commit that referenced this issue Aug 30, 2023
<!--
Open the PR up as a draft until you feel it is ready for a proper
review.

Do not make PR:s from your own `main` branch, as that makes it difficult
for reviewers to add their own fixes.

Add any improvements to the branch as new commits to make it easier for
reviewers to follow the progress. All commits will be squashed to a
single commit once the PR is merged into `main`.

Make sure you mention any issues that this PR closes in the description,
as well as any other related issues.

To get an auto-generated PR description you can put "copilot:summary" or
"copilot:walkthrough" anywhere.
-->

### What

Closes #3105

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3151) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/3151)
- [Docs
preview](https://rerun.io/preview/583e2e5136b747e48e33c0c033936fe2ddd7b0d7/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/583e2e5136b747e48e33c0c033936fe2ddd7b0d7/examples)
<!--EXAMPLES-PREVIEW--><!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Issues relating to the Rerun examples
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants