tilburgsciencehub / website

Learn to work more efficiently on empirical research projects.
https://tilburgsciencehub.com
38 stars 46 forks source link

Article request: Use Dockerhub to share your projects. #1110

Open hannesdatta opened 4 months ago

hannesdatta commented 4 months ago

Title (proposed): Use Dockerhub to share your projects.

Why: This building block would be a logical complement to the one on importing environments with docker and google cloud. After having described in the aforementioned building block how to import an environment in Gcloud from an existing dockerfile, a new building block explaining the user how to read/design these dockerfiles and make them available to collaborators or users aiming to replicate their porjects would complete the cycle of collaborating on projects through docker. Both sides of the process would be covered, export and import.

Originally posted by @DiSanchz in https://github.com/tilburgsciencehub/website/issues/578#issuecomment-1357836485

hannesdatta commented 4 months ago

@Fernando-Iscar - please assign to RA wher you see fit + expand instructions w/ a pointer on which use case to use.

Fernando-Iscar commented 3 months ago

@krzysztof99xd we could co-author this one since eventually we would need to mention it when implementing issue #309. Tell me how it sounds and we could set up a meeting to talk about it in the following week/s.

krzysztof99xd commented 3 months ago

Hey @Fernando-Iscar , thanks for mentioning me! It sounds like a good idea. However, as mentioned during the last meeting with Gergo I would like to focus on finishing some other tasks first. What do you say if we meet 20th or 22nd of March in the afternoon? Let's discuss details on Teams.

Fernando-Iscar commented 3 months ago

Sure @krzysztof99xd, let's talk on 22nd, I'll send you Teams invite.

Fernando-Iscar commented 3 months ago

Hi @krzysztof99xd. As we discussed in our meeting, the initial structure would look like this:


Use Dockerhub to Share Your Projects

Introduction

Brief overview of the content highlighting the importance of sharing Docker containers for project replication and collaboration.

What is Docker?

Explanation of Docker, containerization, and their benefits for development and data science projects.

What is Dockerhub?

Introduction to Dockerhub as a cloud-based repository for Docker images, highlighting its role in sharing and collaboration.

Creating a Docker Image with a Dockerfile

Understanding Dockerfiles

Basics of Dockerfiles, including their structure and how they are used to build Docker images.

Example: Dockerfile for a Python Data Analysis Project

A simple Dockerfile example that sets up a Python environment for a data analysis project.

Building and Sharing Your Docker Image

Building Your Image

Steps to build a Docker image from a Dockerfile.

Exporting an Image to Dockerhub

Guidance on how to tag and push your Docker image to Dockerhub.

Importing an Image for Project Replication

How to pull a Docker image from Dockerhub and run it, ensuring project environment replication.

Summary

Summarizing main insights of the topic covered

Additional Resources

Providing relevant sites worth to visit


Reminder; This should be done before or in pararell with issue #1128 to manage for overlapping information or to recycle the use case example. Also, for the same reason is worth to previously have a look to the Docker content already available in our platform.

Fernando-Iscar commented 3 months ago

Hi @krzysztof99xd, I was double checking the topics on Docker, and this one already covers the basics of our proposed tutorial. Of course we could develop more, for instance, guiding the reader on how to create a DockerHub account or with the Python example itself, but then, it would probably end up overlapping in content with the mentioned topic plus the idea for #1128.

I propose to leave this on pause, and move the conversation to draft #1128.