Skip to content

Make developing/debugging/testing more efficient for developer #2958

Open
@lhw362950217

Description

@lhw362950217

After our code refactory, only workflow mode is officially supported. This makes the developing and debugging more complicated. The complication comes from ways:

  1. Many docker images (dev, ci, server, step...) are involved, building images always costs time.
  2. Workflow will run in a k8s cluster, the internal status of the program is not easy to expose.
  3. Modify code and re-deploy need many steps, which takes a lot of time.
  4. Not enough guide for develop/debug/ci/customize model/build runnable.

After some discussion with other developers, I conclude the following refinement todo, most of them are doc modifications:

  1. Developer guide
    • Local developing environment deploy guide
    • How to build relative images
    • How to do unit-test in our ci image
    • How to do e2e test in local playground, (like how to sharing code with VM, how to submit a test program to the cluster)
    • How to re-deploy component in local playground
    • How to release a version
  2. Update model contribution doc
  3. Write runnable building doc
  4. Speed up docker image pulling
  5. Refine our image Dockerfile, make re-build faster

Metadata

Metadata

Labels

RefactorydocDocument related request/bug

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions