Skip to content

Docker based module development setup is confusing #2023

@Woland2k

Description

@Woland2k

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.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions