Skip to content

Commit

Permalink
docs(global): add note about devbox on contributing docs
Browse files Browse the repository at this point in the history
Also a bit of minimal changes over at the README days ago.

On-behalf-of: @recaptime-dev <oss@crew.recaptime.eu.org>
Signed-off-by: Andrei Jiroh Halili (RecapTime.dev) <ajhalili2006@crew.recaptime.eu.org>
  • Loading branch information
ajhalili2006 committed Aug 23, 2023
1 parent 37a45d0 commit 70539b0
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .gitpod/buildkitd.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ root = "/workspace/buildkit"
rootless = false
gc = true
gckeepstorage = 40000
max-parallelism = 16
max-parallelism = 16
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contribution Guidelines + Docs for Contributors

## Before you start

While the workspace images we maintain here are probably different from [the upstream](https://github.com/gitpod-io/workspace-images), we're currently
limited to the tools and languages that we at Recap Time Squad use in our daily work. If you think that bringing a tool here would be more
suitable for everyone, we may suggest to submit it to upstream's issue tracker for consideration.

If you still want to add a new image here, it's often required to get an acknowledgement from the maintainers by filling a new ticket in our GitLab (or
GitHub) issue tracker so that we can assess if we have the enough bandwidth to maintain the image.

While using Gitpod is often the preferred way to setup your developer environment without cluttering your local setup
and to easily contribute to the project,
we also have configurations for both Dev Containers and GitHub Codespaces if you prefer those.

Maintainers have access to push branches to this repo whereas the community is expected to fork this repo in order to raise a merge request to keep things
less cluttered.

## Tools

> **Warning**: If you proceed with Devbox, please be reminded that we'll be working on a workaround to make Dazzle installable via nix flakes.
If you want a nix-based hybrid dev env setup, consider using [`devbox`](https://jetpack.io/devbox/docs/contributor-quickstart/) and just run `devbox shell`
(or use its [VS Code extension](https://www.jetpack.io/devbox/docs/ide_configuration/vscode/)).

If you prefer to set things up manually, you need:

1. Docker Engine (Linux-only) or Docker Desktop (Windows, macOS, Linux) to run a local container registry for build caching.
2. The [buildkitd binary](https://github.com/moby/buildkit), as used by Dazzle
3. The [Dazzle CLI (and its companion utility program)](https://github.com/gitpod-io/dazzle/) itself, primarily to build the images.

Optionally, you also need:

* Hadolint and ShellCheck for linting shell scripts and Dockerfiles in VS Code

## Building images

We use the `build-*.sh` scripts from the upstream and condense them into one script for easy maintainability, as maintained in the `dazzle-build-script`
repository.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,24 @@ All images are available on [the project's RHQCR namespace](https://quay.io/gitp

## Available Images

<!-- markdownlint-disable MD013 -->

### By image combinations

| Name | Description | CI Badges and Docs |
| ---- | ---- | ---- |
| Base Image (`base`) | The base image for all, based on latest Ubuntu LTS (currently `buildpack-deps:jammy`) | [![Link to docs badge](https://img.shields.io/badge/Read%20image%20docs-blue?logo=gitpod)](./base/README.md) |

### By chunks

TBD

## Contributing

You can follow the detailed guide on how to contribute [here](CONTRIBUTING.md). Please be reminded that signing-off
your commits is required per [the Linux DCO](https://policies.recaptime.eu.org/opensource/linux-dco).

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/gitpod-io/workspace-images)
| Development Environment | Deep link / Docs |
| --- | --- |
| Gitpod SaaS | [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/gitpod-io/workspace-images) |
| GitHub Codespaces | [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/gitpodify/workspace-images?quickstart=1) |

0 comments on commit 70539b0

Please sign in to comment.