-
Notifications
You must be signed in to change notification settings - Fork 0
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
feat(doc): add overview content to bao-classic config documentation #66
feat(doc): add overview content to bao-classic config documentation #66
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMHO the overview section sufficiently explains at a high-level the need and use of the config
file. Just added some format typos, but don't forget to check trailing whitespaces and probably lines will surpass the characters limit.
3311afc
to
d120e6f
Compare
2514d46
to
69e5cd1
Compare
Don't forget to squash all the commits into only one meaningful commit @Diogo21Costa to maintain the history clean. |
bb9016a
to
326d3bb
Compare
f4afd64
to
a38a4a8
Compare
@danielRep @josecm I've improved the guest load description by including a description of the VM_IMAGE macro and a pointer to the 'Guest Image' section, where later it will be described how the guest image is configured. Can you please provide feedback on this change? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small format tweaks @Diogo21Costa . After these small changes, is fine by me.
@danielRep Fully agree with all the points, thank you for the review! Applied all the changes in 133b776 Currently, the gitlint checker is failing due to unsigned commits, in specific the following ones: 77e63cf - fix(doc): improve documentation readability To solve the issue and to maintain the history clean, may I squash all the "fix(doc)" commits into a single one? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Don't forget to review the git history.
Yes, all those commits should be squashed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this still needs a small iteration.
Please, also clean the commit history.
@Diogo21Costa you should also refactor this to use the new column limit of 100. |
Fix the checker issues when you have the time @Diogo21Costa . You need to rebase the branches with main to avoid the format-check triggering and rewriting the git history too. |
c7f6a81
to
89299c7
Compare
@Diogo21Costa please fix the commit history and messages, as well as the formatting errors. |
89299c7
to
2dec63a
Compare
40f6ede
to
1ccdf58
Compare
Signed-off-by: Diogo21Costa <diogoandreveigacosta@gmail.com>
2dec63a
to
6619845
Compare
@josecm @danielRep Fixed the commit history and the formatting errors, thanks for the review! |
PR Description
In this pull request, I'm adding content to the "Overview" section of the getting started documentation for the Bao hypervisor.
This update focuses solely on the "Overview" section, providing a detailed description of the configuration file and its different available fields.
Do you have any suggestions or feedback concerning the content provided in the "Overview" section?