dapr / dapr/quickstarts

Document Docker makefile commands for each quickstart

Open
#912 0 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Java
Stars
1.1k
Forks
547
PR merge metrics
No merged PRs in 30d

Description

There is a [docker.mk](https://github.com/dapr/quickstarts/blob/master/docker.mk) file that creates, builds, and pushes the Docker images and manifests for each quickstart. Currently, these are used in GitHub actions but there is no documentation on how to use this file to build and create the manifests no in the GitHub action.

There should be a section added to every quickstart that documents how to run the following makefile definitions:
- genDockerImageBuild
- genDockerImagePush
- genDockerManifestCreate
- genDockerManifestPush

Specifically, this would be good to add to each quickstart for creating Dockerfile manifests that could be used to deploy the quickstarts on k8s.

Contributor guide

Open the contributing guide

Research direction

Start with docker.mk and the existing GitHub Actions that use it, then inspect each quickstart's documentation. Document how to run genDockerImageBuild, genDockerImagePush, genDockerManifestCreate, and genDockerManifestPush for creating Docker manifests usable on Kubernetes. Done means every quickstart has instructions covering these four definitions outside the GitHub Action.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
devops, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.