Skip to content

Create github pages to visualize reports #1

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

Closed
carlossvg opened this issue Mar 4, 2022 · 5 comments
Closed

Create github pages to visualize reports #1

carlossvg opened this issue Mar 4, 2022 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@carlossvg
Copy link
Contributor

Acceptance Criteria

  • Create github pages to visualize the generated reports in HTML and other images.
@carlossvg carlossvg added the enhancement New feature or request label Mar 4, 2022
@carlossvg
Copy link
Contributor Author

Connected to ros-realtime/reference-system#75

FYI @flynneva

@carlossvg
Copy link
Contributor Author

carlossvg commented Mar 12, 2022

@LanderU I used the following tool to generate HTML file indexes: https://github.com/libthinkpad/apindex

After installing it you simply run the following command in the project root: apindex benchmark_results. It generates HTML files for the git directories too but I'm excluding them from git.

@carlossvg
Copy link
Contributor Author

@LanderU This is how it works so far:

  • A github pages project is created with Jekyll and slate theme
  • I edited the default index.markdown with all the markdown links and info we want to add
  • I added the index.html for the benchmark_results
  • In order to update the benchmark_results indexes you can run apindex benchmark_result from the root directory

@carlossvg
Copy link
Contributor Author

@LanderU To generate the indexes use the fork (fork of a fork of a fork) I created here https://github.com/carlossvg/apindex-v3

It includes a script to install the tool a yml file to automatically generate the indexes and update the github pages.

@carlossvg
Copy link
Contributor Author

@LanderU Completed! Thanks for your support!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

2 participants