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

README and repo organization #79

Closed
2 tasks
boxrhcp opened this issue Jan 21, 2020 · 0 comments
Closed
2 tasks

README and repo organization #79

boxrhcp opened this issue Jan 21, 2020 · 0 comments
Assignees
Labels

Comments

@boxrhcp
Copy link
Collaborator

boxrhcp commented Jan 21, 2020

Task

Detailed Description

The repo is accumulating scripts and the README needs to be updated accordingly.
The README should include not only the directory map of the repo but also the installation and execution instructions. It must also explain every value in the json config file and list every dependency used.
The repo structure should be reorganized to be more descriptive, specifically follow the modular organization.
Inside bin we should have the following:
main.py
sut/ - with all the SUT deployment automation scripts and files needed
workload/ - with all the workload (caliper) scripts and configuration files needed
analyzer/ - with all the aggregator scripts and possible scripts that deal with reading results.

This organization needs to change correctly every path that is written in every script or errors will appear.

Acceptance Criteria

  • The tool is running without any errors

  • The README is clear and describes all the information requested in the task

Associated story

#30

Notes

#98

@boxrhcp boxrhcp added the task label Jan 21, 2020
@boxrhcp boxrhcp added this to the Sprint 3 28/01 milestone Jan 21, 2020
@XhorxhinaT XhorxhinaT self-assigned this Jan 22, 2020
@XhorxhinaT XhorxhinaT mentioned this issue Jan 30, 2020
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants