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.

Sign up for GitHub

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

Jump to bottom

[FEATURE REQUEST] Restructure Epicli project folder #2643

Closed
8 of 13 tasks
seriva opened this issue Sep 29, 2021 · 1 comment
Closed
8 of 13 tasks

[FEATURE REQUEST] Restructure Epicli project folder #2643

seriva opened this issue Sep 29, 2021 · 1 comment
Assignees
@seriva @przemyslavic
Labels
area/development type/improvement
Milestone
Improvements

Comments

@seriva
Copy link
Collaborator

seriva commented Sep 29, 2021 •
edited by mkyc
Loading

Is your feature request related to a problem? Please describe.
Currently the core of the project "Epicli" lives in /core/src/epicli with the idea that this would extended with different additional projects. However as we now know we will transition to modules down the line. This setup does not make it very intuitive to work with as the devcontainer needs to be opened in /core/src/epicli and for documentation an extra windows needs to be opened.

Describe the solution you'd like
Because of this we want to restructure the project:

  • Move the content of /core/src/epicli to the root of the project so that we can open the project in one single workspace/devcontainer. The structure of what is inside /core/src/epicli will be left in tact for now.
  • Merge /core/src/epicli/.gitignore into /.gitignore
  • Fix paths for docker build inside:
    • /core/src/epicli/setup.py
    • /.dockerignore
    • /Dockerfile
  • Remove old certificate code in /core/src/epicli/.devcontainer/cert. This has not been maintained/tested properly when COVID started.
  • Move CHANGELOG-x.x.md files to a subfolder inside docs and update CHANGELOG.md paths to these version
  • Update /docs/home/DEVELOPMENT.md
  • Add markdownlint plugin to devcontainer
  • Adjust build pipelines for development branch

Describe alternatives you've considered
None

Additional context
https://docs.python-guide.org/writing/structure/

DoD checklist

  • Changelog updated
  • COMPONENTS.md updated / doesn't need to be updated
  • Schema updated / doesn't need to be updated
  • Feature has automated tests
  • Automated tests passed (QA pipelines)
    • apply
    • upgrade
  • Idempotency tested
  • Documentation added / updated / doesn't need to be updated
  • All conversations in PR resolved
  • Solution meets requirements and is done according to design doc
  • Usage compliant with license
  • Backport tasks created / doesn't need to be backported
@seriva seriva added this to the Improvements milestone Sep 29, 2021
@seriva seriva self-assigned this Sep 29, 2021
This was referenced Sep 30, 2021
Merged
Merged
Merged
Merged
Merged
@przemyslavic przemyslavic self-assigned this Oct 6, 2021
@przemyslavic
Copy link
Collaborator

Tested together with #2666 (part 2).

@mkyc mkyc closed this as completed Oct 8, 2021
This was referenced Oct 8, 2021
Merged
Closed
seriva added a commit that referenced this issue Oct 14, 2021
@seriva
Removed legacy code and some minor refactoring (#2677)
bfd1414 
- Removed legacy code for Epiphany < 0.3.
- Refactored build_saver.py and renamed to build_io.py as we do not only save.
- Updated tests to reflect all changes.
- Also added missing changelogs for #2643, #2666
- Added fixes for #2497 which where outstanding in #2652 and reported in: #2497 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@seriva seriva

@przemyslavic przemyslavic

Labels
area/development type/improvement
Projects
None yet
Milestone
Improvements
Development

No branches or pull requests
4 participants
@atsikham @seriva @mkyc @przemyslavic