covalent icon indicating copy to clipboard operation
covalent copied to clipboard

Enhance Documentation for Using Custom Docker Images with Covalent Remote Plugins

Open santoshkumarradha opened this issue 1 year ago • 3 comments

What should we add?

We have sporadically mentioned how to use custom Docker images with Covalent executors in our documentation, particularly in the context of AWS Lambda Executors (link). However, we believe there's a need for more comprehensive and dedicated documentation to guide users through the process of utilizing custom Docker images as environments for Covalent remote plugins. This enhanced documentation should also outline the constraints and best practices for creating and using custom images effectively.

Proposed Changes:

  • Create a dedicated how-to guide for using custom Docker images with Covalent remote plugins.
  • Detail the constraints and requirements that custom Docker images must follow to work seamlessly with Covalent.
  • For plugins that have unique requirements or considerations, provide separate documentation pages for each plugin.
  • Implement a central "How-to use custom Images for plugins" guide that describes the concept and links to individual plugin-specific documentation.

santoshkumarradha avatar Sep 09 '23 00:09 santoshkumarradha

Hey, could you please assign this issue to me under hacktoberfest

VividhPandey003 avatar Oct 11 '23 04:10 VividhPandey003

I would like to work on this

neelshah2409 avatar Oct 26 '23 12:10 neelshah2409

Please feel free to work on this @neelshah2409 and pass on a PR.

santoshkumarradha avatar Oct 26 '23 13:10 santoshkumarradha