BioJulia / BioJuliaDocs

MIT License
5 stars 2 forks source link

Create a dev container definition #2

Closed M-PERSIC closed 1 year ago

M-PERSIC commented 1 year ago

Is your feature request related to a problem? Please describe. Ideally, users needn't worry about setting up a development environment when contributing. Some would prefer having an automated or easier process, such as how Docker templates can be used as recipes to setup a local dev environment.

Describe the solution you'd like "Dev container" definitions extend the idea of containers for development by providing a JSON recipe to mount custom containers on VSCode and other IDEs. Thus, users may simply generate dev environments from a given devcontainer.json file provided in the repo.

BioJuliaDocs is a community-driven intiative, thus we would like to avoid build issues. Setting it up locally is, at the time of writing, straightfoward enough (install Julia, clone the repo, julia docs/make.jl), therefore the definition should be simple. This setup would provide good practice for extending dev containers to other BioJulia repos.

Describe alternatives you've considered Provide an instructions list detailing how to install/run Julia and BioJuliaDocs locally.

Additional context Relevant documentation for dev containers and Codespaces .