Skip to content

Developer Guide needs to mention that Docker is one of the prerequisite. #3267

Open
@jgao1025

Description

@jgao1025

Background

In many verification scripts (triggered by running make verify), Docker is frequently used as a pre-check tool in many instances.

Changes

It is would be nice to mention in the Dev Guide that installing Docker as a runtime container is preferable.

How to start work on this?

Please follow this section.

Original request

          It was already a prerequisite, as other `verify-*.sh` scripts make use of it (https://github.com/kubernetes-sigs/gateway-api/tree/main/hack/verify-docker-build.sh#L25-L26, https://github.com/kubernetes-sigs/gateway-api/blob/main/hack/verify-golint.sh#L33-L41). That said, I 100% agree we should clearly state it in the [verify](https://github.com/kubernetes-sigs/gateway-api/blob/main/site-src/contributing/devguide.md#verify) section of our docs. Given the PR you already raised on that side, would you be interested in updating such a section as well with all the deps? That would be great and much appreciated.

Originally posted by @mlavacca in #3167 (comment)

### Tasks

Metadata

Metadata

Labels

good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions