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

Use examples' README front matter to generate the demo website #2429

Closed
abey79 opened this issue Jun 14, 2023 · 1 comment
Closed

Use examples' README front matter to generate the demo website #2429

abey79 opened this issue Jun 14, 2023 · 1 comment
Labels
🧑‍💻 dev experience developer experience (excluding CI) enhancement New feature or request examples Issues relating to the Rerun examples 🕸️ web regarding running the viewer in a browser

Comments

@abey79
Copy link
Member

abey79 commented Jun 14, 2023

Currently, a list of of examples and related metadata is hardcoded in script/build_demo_app.py, but this is somewhat redundant with the examples' README front matter. I suggest improving this script such that:

  • it pulls all example whose front matter includes demo: true
  • it pulls the metadata from the front matter

Examples' front matter will need to include:

  • demo: true (if the example is to be included as demo)
  • description: ... (needed anyways for the example landing page)
  • demo_build_args: [] for optional build argument when generating the demo site

Some mechanism should also be devised to generate/avoid script/requirements-web-demo.txt.

@abey79 abey79 added enhancement New feature or request 🕸️ web regarding running the viewer in a browser 🧑‍💻 dev experience developer experience (excluding CI) examples Issues relating to the Rerun examples labels Jun 14, 2023
@abey79 abey79 mentioned this issue Jun 14, 2023
1 task
@jprochazk
Copy link
Member

This was done in #4418 - the build_examples and build_examples_manifest binaries don't hardcore a list of examples anymore, everything is read from the filesystem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧑‍💻 dev experience developer experience (excluding CI) enhancement New feature or request examples Issues relating to the Rerun examples 🕸️ web regarding running the viewer in a browser
Projects
None yet
Development

No branches or pull requests

2 participants