Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for build your own image feature #186

Open
1 task
j08lue opened this issue Dec 5, 2024 · 3 comments
Open
1 task

Add docs for build your own image feature #186

j08lue opened this issue Dec 5, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@j08lue
Copy link
Contributor

j08lue commented Dec 5, 2024

We now have a working feature on https://hub.openveda.cloud/ for users to build their own image for JupyterLab off of a repository that conforms to certain lightweight standards (Binder).

Image

Image

We need to document this feature and its limitations

Acceptance criteria

  • Added docs about when to use this feature, how, and when not
@j08lue j08lue added the documentation Improvements or additions to documentation label Dec 5, 2024
@j08lue j08lue self-assigned this Dec 5, 2024
@wildintellect
Copy link
Contributor

Questions to answer:

  • What do you need to fill in the boxes?
  • How does it know when to build again? only when you change the env.yaml or on every commit? most people will set a branch and always use that never tagging or specifying specific commits.
  • What needs to exist in your repo to customize the build (does this currently only support conda customization?)
  • What upstream docs like repo2docker should we reference?

@wildintellect
Copy link
Contributor

Things we've noticed:

  • It's case sensitive github.com/MAAP-Project/sar2-d2 and github.com/maap-project/sar2-d2 both built. 😱

Where's the source code for this feature @yuvipanda?

@yuvipanda
Copy link

What needs to exist in your repo to customize the build (does this currently only support conda customization?)

https://repo2docker.readthedocs.io/en/latest/config_files.html has a list of files that are interpreted automatically. If you have a Dockerfile it ignores all other files and only uses that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants