Added documentation, changed to src layout - Githubissues

osl-incubator / sugar

Simplify the usage of containers

https://osl-incubator.github.io/sugar/

BSD 3-Clause "New" or "Revised" License

6 stars 8 forks source link

Added documentation, changed to src layout #93

Closed joel5vega closed 11 months ago

joel5vega commented 11 months ago

Pull Request description

Changed the layout to src/containers_sugar
Adding files for documentation

How to test these changes

Verify directories
test documentation page: https://osl-incubator.github.io/containers-sugar
...

Pull Request checklists

This PR is a:

[ ] bug-fix
[ X ] new feature
[ X ] maintenance

About this PR:

[ X ] the tests are executed on CI.
[ X ] pre-commit hooks were executed locally.
[ ] this PR requires a project documentation update.

Author's checklist:

[ X ] I have reviewed the changes and it contains no misspelling.
[ X ] The code is well commented, especially in the parts that contain more complexity.
[ X ] New and old tests passed locally.

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved .

xmnlab commented 11 months ago

Hi @joel5vega , thanks for working on that. Normally we have just 1 PR for each issue we are resolving.

You had already started one PR for the documentation, but you opened another PR for the documentation again and the the src.

Could you please keep in the PR just the changes for the the src layout? And we move forward the documentation changes in the other PR, please?