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

Docker based module development setup is confusing #2023

Open
Woland2k opened this issue Sep 11, 2020 · 4 comments
Open

Docker based module development setup is confusing #2023

Woland2k opened this issue Sep 11, 2020 · 4 comments
Assignees

Comments

@Woland2k
Copy link
Contributor

Woland2k commented Sep 11, 2020

Referring to this guide:
https://virtocommerce.com/docs/latest/developer-guide/modules-development-via-docker/

Here are some improvements:

  1. Should be cross referenced right from the create new module guide: https://virtocommerce.com/docs/latest/developer-guide/create-new-module/ (which also needs to be simplified, especially since there is a VS.NET extension that makes most of it irrelevant).
  2. It needs to be structured in step by step manner, with details explanation provided at the bottom if needed.
  3. It should be made clear that the whole folder including .env file needs to be saved locally, for now it implies that only docker-compose.yaml needs to be downloaded (ideally that is the only file that should be required).
  4. Docker image naming for the platform is confusing, it still has "alpha" in it, when we do have a release.
  5. Image download from github fails by default with the following exception: ERROR: Service 'virtocommerce.platform.web' failed to build: Get https://docker.pkg.github.com/v2/virtocommerce/vc-platform/platform/manifests/dev-3.15.0-alpha.11532-56692a4d: no basic auth credentials. Should include detailed instructions on logging into github and getting a token.
  6. Missing instructions on removing environment.
  7. Missing instructions on what URL should be opened to launch platform.
@mvktsk
Copy link
Contributor

mvktsk commented Sep 17, 2020

@Woland2k please review changes #2033

@Woland2k
Copy link
Contributor Author

@mvktsk, reviewed, added some comments. The main issue for me is that symbolic links don't work when running in docker linux environment which makes developing modules a pain. Also, what happens when module is recompiled? Those changes don't typically get picked up unless platform is restarted which requires stopping and starting of docker, is that issue solved?

@mvktsk
Copy link
Contributor

mvktsk commented Sep 21, 2020

@Woland2k, comments fixed

  1. Yes, symbolic links don't. Docs rewrite.
  2. Added command to docker-compose for auto-restart container

@Woland2k
Copy link
Contributor Author

Woland2k commented Sep 22, 2020

  1. We need to figure out how to make process more efficient without manually coping the files. Maybe some add-on or target configuration so files are deployed to docker modules folder automatically? @tatarincev

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants