Skip to content

Conversation

@JavierCladellas
Copy link
Collaborator

@JavierCladellas JavierCladellas commented Nov 20, 2024

As of #119 , the docs/modules/ROOT/ pages/ should be almost empty (will contain index.html), the pages generation will be completely handled by GitHub runners.

I propose that users generate their own websites under the same ROOT module (there should be no conflicts).
For this: (there is a --website flag that automates this process)

  1. execute-benchmark --machine-config ... --benchmark-config ... --plots-config ... Outputs will be stored depending on the specified on the machine config, otherwise, they can use the --move-results option.
    This script will generate a webiste_config.json file containing the executed benchmark hierarchy (will be updated if more benchmarks are executed ) . This file can be later on customised if needed (add descriptions, variables to show, etc.)
  2. Assuming benchmark outputs are stored under ./reports/
    render-benchmarks --config_file ./reports/website_config.json --modules_path ./docs/modules/ROOT/pages
  3. npm run antora
  4. npm run start
  5. Open localhost (or any configured ips)

@vincentchabannes @prudhomm Any suggestions for how users should be able to generate and visualise their own benchmarking website ?

@JavierCladellas JavierCladellas added enhancement A new feature or request benchmarking Issues related to benchmarking labels Nov 20, 2024
@JavierCladellas JavierCladellas self-assigned this Nov 20, 2024
@JavierCladellas JavierCladellas linked an issue Nov 20, 2024 that may be closed by this pull request
@netlify
Copy link

netlify bot commented Nov 20, 2024

Deploy Preview for benchmarking-polite-crostata-92f389 ready!

Name Link
🔨 Latest commit dd6cda1
🔍 Latest deploy log https://app.netlify.com/sites/benchmarking-polite-crostata-92f389/deploys/6745bf939f18100008d6565b
😎 Deploy Preview https://deploy-preview-148--benchmarking-polite-crostata-92f389.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@prudhomm
Copy link
Member

@JavierCladellas I need more context with respect to the workflow here. when is this done ? initially ? at each benchmarking, ?

@prudhomm
Copy link
Member

would you have a graphics explaining the workflow ?

@JavierCladellas
Copy link
Collaborator Author

@prudhomm

@JavierCladellas I need more context with respect to the workflow here. when is this done ? initially ? at each benchmarking, ?

At each benchmark, a website_config.json file is updated (or created if first time).
The --website will render the website files based on the existing website_configuration.json, compile and start a server.

I have started a sequence diagram in here: https://www.figma.com/board/Icw2MOg9W5iGxRaVvXfk3a/benchmark-code-design?node-id=0-1&node-type=canvas&t=uBcKWX7Skt1T4XDw-0

benchmark code design-3

@vincentchabannes vincentchabannes merged commit 0c8515e into master Nov 26, 2024
8 checks passed
@vincentchabannes vincentchabannes deleted the 126-handle-custom-website-generation branch November 26, 2024 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

benchmarking Issues related to benchmarking enhancement A new feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Handle custom website generation

4 participants