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

Add missing examples to the example manifest #5666

Open
4 of 17 tasks
nikolausWest opened this issue Mar 25, 2024 · 1 comment
Open
4 of 17 tasks

Add missing examples to the example manifest #5666

nikolausWest opened this issue Mar 25, 2024 · 1 comment
Labels
examples Issues relating to the Rerun examples

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Mar 25, 2024

There are several useful examples that we keep in separate repositories that aren't currently easy to find under rerun.io/examples. There are also examples we have in the repository that aren't discoverable on the website. We should add these to the example manifest to make the easier to find for our users. This includes, any ROS bridges or interesting dataloaders.

Use this figma page to format the thumbnail.

Related to:

External examples:

Internal examples:

  • shared_recordings
  • log_file “rerun_example_log_file”
  • external_data_loader
  • incremental_logging
  • notebook
  • stdio

Code snippets that aren't used anywhere in docs:

  • manual_indicator
  • quick_start_connect
  • quick_start_spawn
@nikolausWest nikolausWest added the examples Issues relating to the Rerun examples label Mar 25, 2024
@emilk
Copy link
Member

emilk commented Mar 27, 2024

We should maybe add a lint so that we don't forget adding examples to the manifest

@nikolausWest nikolausWest changed the title Add all external examples to the example manifest Add missing examples to the example manifest Mar 28, 2024
@abey79 abey79 added this to the 0.15 milestone Apr 4, 2024
emilk pushed a commit that referenced this issue Apr 4, 2024
### What

- Part of ##5666

### 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 the web demo (if applicable):
* Using newly built examples:
[rerun.io/viewer](https://rerun.io/viewer/pr/5785)
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/5785?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/5785?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/5785)
- [Docs
preview](https://rerun.io/preview/d2b16ddde46cc35b0e0a174688b76ddc84439429/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/d2b16ddde46cc35b0e0a174688b76ddc84439429/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
abey79 added a commit that referenced this issue Apr 4, 2024
### What

- Part of #5666

### 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 the web demo (if applicable):
* Using newly built examples:
[rerun.io/viewer](https://rerun.io/viewer/pr/5789)
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/5789?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/5789?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/5789)
- [Docs
preview](https://rerun.io/preview/ee289d8824bb1107f80a9418c756fb83f963fd0e/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/ee289d8824bb1107f80a9418c756fb83f963fd0e/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
abey79 added a commit that referenced this issue Apr 4, 2024
### What

- Part of #5666 

Also added a linkinator exception as apparently tensorflow.org blocks CI
🤷🏻

### 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 the web demo (if applicable):
* Using newly built examples:
[rerun.io/viewer](https://rerun.io/viewer/pr/5790)
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/5790?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/5790?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/5790)
- [Docs
preview](https://rerun.io/preview/72ffd3e4937cfa0e6b4ae7ce488eecbaf2a253ca/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/72ffd3e4937cfa0e6b4ae7ce488eecbaf2a253ca/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
@Wumpf Wumpf modified the milestones: 0.15, 0.15.1 Apr 11, 2024
@emilk emilk removed this from the 0.15.1 milestone Apr 16, 2024
@emilk emilk added this to the Spring Cleaning milestone Apr 24, 2024
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

No branches or pull requests

4 participants