Skip to content
This repository was archived by the owner on Dec 11, 2024. It is now read-only.

Instructions don't match code #6

Open
jmunroe opened this issue Mar 6, 2023 · 0 comments
Open

Instructions don't match code #6

jmunroe opened this issue Mar 6, 2023 · 0 comments

Comments

@jmunroe
Copy link

jmunroe commented Mar 6, 2023

Context

As the 'default 2i2c image' for our hubs, this image will be used a point of reference for communities trying to develop their own images.

We state in the Readme:

This is the default image used by the 2i2c community hubs deployed from https://github.com/2i2c-org/infrastructure.

and then almost right away

About this template repository

  • It provides an example of a environment.yml conda configuration file.
    This file can be used to list all the conda packages that need to be installed by repo2docker in
    your environment.
    The repo2docker-action will update the base repo2docker
    conda environment with the packages listed in this environment.yml file.

But this image uses a requirements.txt file and not an environment.yml file. This is a possible source of confusion for our communities who do not have expertise in python environment management.

Proposal

We should convert the requirements.txt to a environment.yml to be consistent with our documentation and the hub-image-template.

Updates and actions

No response

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
No open projects
Status: Ready to work
Development

No branches or pull requests

1 participant