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.

Sign up for GitHub

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

Jump to bottom

Replace YAML with TOML in our example markdown frontmatter #3355

Closed
emilk opened this issue Sep 18, 2023 · 0 comments · Fixed by #4553
Closed

Replace YAML with TOML in our example markdown frontmatter #3355

emilk opened this issue Sep 18, 2023 · 0 comments · Fixed by #4553
Assignees
@jprochazk
Labels
🧑‍💻 dev experience developer experience (excluding CI) enhancement New feature or request

Comments

@emilk
Copy link
Member

emilk commented Sep 18, 2023

We need to update:

  • landing
  • build_demo_app.py
  • crates/re_viewer/build.rs
@emilk emilk added enhancement New feature or request 👀 needs triage This issue needs to be triaged by the Rerun team 🧑‍💻 dev experience developer experience (excluding CI) and removed 👀 needs triage This issue needs to be triaged by the Rerun team labels Sep 18, 2023
@emilk emilk mentioned this issue Sep 18, 2023
Merged
3 tasks
@jprochazk jprochazk self-assigned this Dec 14, 2023
@jprochazk jprochazk mentioned this issue Dec 15, 2023
Merged
10 tasks
emilk added a commit that referenced this issue Dec 19, 2023
@jprochazk @emilk
Use TOML in examples (#4553)
fe6400e 
### What

Closes #3355
Closes #2431

- [x] Convert all example `README.md` frontmatter to use TOML instead of
YAML
- [x] Convert `manifest.yml` to a `.toml` file
- [x] Support reading TOML frontmatter everywhere (linting,
`thumbnails.py`, `re_build_examples`)
- [x] Simplify both `README.md` frontmatter and the manifest file by
inferring more information from the filesystem
- [x] Use HTML comments instead of `---` for delimiters
- [x] Update `landing` to support TOML and new manifest/README formats
  - rerun-io/landing#594

After merging this PR, merge [the PR in
landing](rerun-io/landing#594) by following the
instructions in the PR body there.

### 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:
[app.rerun.io](https://app.rerun.io/pr/4553/index.html)
* Using examples from latest `main` build:
[app.rerun.io](https://app.rerun.io/pr/4553/index.html?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[app.rerun.io](https://app.rerun.io/pr/4553/index.html?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

- [PR Build Summary](https://build.rerun.io/pr/4553)
- [Docs
preview](https://rerun.io/preview/7588e64e5e2f3676ebeb40fe75a3e8185da0b9e9/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/7588e64e5e2f3676ebeb40fe75a3e8185da0b9e9/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

---------

Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jprochazk jprochazk

Labels
🧑‍💻 dev experience developer experience (excluding CI) enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use TOML for example readme frontmatter rerun-io/rerun
2 participants
@emilk @jprochazk