From 9dc8828c15e56454baed33fb5a65d6bd8ec923ad Mon Sep 17 00:00:00 2001 From: Salim Kayal Date: Wed, 29 Oct 2025 12:04:51 +0100 Subject: [PATCH 1/4] docs: update readme to add user oriented documentation --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f550a34..eab8773 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,32 @@ # renku-frontend-buildpacks -This project provides a set of buildpacks and builders for deploying Renku frontend applications. It -includes buildpacks for various frontend frameworks and a builder that orchestrates the build -process. +This project provides a comprehensive set of Cloud Native Buildpacks and a specialized `selector` +builder designed to streamline the deployment of Renku frontend applications and development +environments. Whether you're setting up JupyterLab, RStudio, or VSCode (via Vscodium) in your Renku +project, these buildpacks simplify the process by intelligently detecting your project's needs and +configuring the appropriate environment. + +The `selector` builder acts as an orchestrator, integrating various frontend frameworks and +essential tools (like Python dependency management and kernel installers) to create ready-to-use +images. This allows Renku users to focus on their data science work without deep knowledge of +underlying containerization. + +For automated image building within your CI/CD pipelines, you can leverage the provided GitHub +Action [actions/build-image](actions/build-image/README.md). This action simplifies the `pack build` +process, allowing you to easily specify the desired `frontend`, `tags`, `builder-version`, and +`run-image` directly in your workflows. + +To get started with manual builds, you'll primarily interact with the +[`pack` CLI](https://buildpacks.io/docs/for-platform-operators/how-to/integrate-ci/pack/), using the +`selector` builder to build your project. For example: + +```bash +pack build my-renku-environment --builder ghcr.io/swissdatasciencecenter/renku-frontend-buildpacks/selector:0.1.0 --path . +``` + +This command will leverage the `selector` builder (using version `0.1.0` as an example) to +automatically detect and configure your Renku environment based on your project's files, and in this +example, push the resulting image to `my-renku-environment`. ## Directory Structure From 8dd0f01742023b01c5d9f11557a3a1f34751d9af Mon Sep 17 00:00:00 2001 From: Salim Kayal Date: Thu, 30 Oct 2025 15:15:17 +0100 Subject: [PATCH 2/4] fix: naming Co-authored-by: Flora Thiebaut --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index eab8773..32a1e79 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This project provides a comprehensive set of Cloud Native Buildpacks and a specialized `selector` builder designed to streamline the deployment of Renku frontend applications and development -environments. Whether you're setting up JupyterLab, RStudio, or VSCode (via Vscodium) in your Renku +environments. Whether you're setting up JupyterLab, RStudio, or Vscodium in your Renku project, these buildpacks simplify the process by intelligently detecting your project's needs and configuring the appropriate environment. From e9c529750e1bee82e7f683821606c8559beb6b7a Mon Sep 17 00:00:00 2001 From: Salim Kayal Date: Thu, 30 Oct 2025 15:15:59 +0100 Subject: [PATCH 3/4] fix: specificity Co-authored-by: Flora Thiebaut --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 32a1e79..207358b 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ project, these buildpacks simplify the process by intelligently detecting your p configuring the appropriate environment. The `selector` builder acts as an orchestrator, integrating various frontend frameworks and -essential tools (like Python dependency management and kernel installers) to create ready-to-use +essential tools (like Python dependency management and Jupyter kernel installers) to create ready-to-use images. This allows Renku users to focus on their data science work without deep knowledge of underlying containerization. From fc782a01289df20d826f4be5a8ad9d1819d97d09 Mon Sep 17 00:00:00 2001 From: Salim Kayal Date: Thu, 30 Oct 2025 15:24:32 +0100 Subject: [PATCH 4/4] fix: publishing info --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 207358b..ad4bd34 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,11 @@ To get started with manual builds, you'll primarily interact with the `selector` builder to build your project. For example: ```bash -pack build my-renku-environment --builder ghcr.io/swissdatasciencecenter/renku-frontend-buildpacks/selector:0.1.0 --path . +pack build my-user/my-renku-environment --builder ghcr.io/swissdatasciencecenter/renku-frontend-buildpacks/selector:0.1.0 --path . ``` This command will leverage the `selector` builder (using version `0.1.0` as an example) to -automatically detect and configure your Renku environment based on your project's files, and in this -example, push the resulting image to `my-renku-environment`. +automatically detect and configure your Renku environment based on your project's files. ## Directory Structure