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

jgao1025 commented 2 months ago

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 https://github.com/kubernetes-sigs/gateway-api/pull/3167#discussion_r1714869211_

### Tasks

jgao1025 commented 2 months ago

/kind documentation

jgao1025 commented 2 months ago

/good-first-issue /help

k8s-ci-robot commented 2 months ago

@jgao1025: This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

Why are we solving this issue?
To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
Does this issue have zero to low barrier of entry?
How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to [this](https://github.com/kubernetes-sigs/gateway-api/issues/3267): >/good-first-issue >/help Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

Nishant-k-sagar commented 2 months ago

Hey @jgao1025 I would like to work on this issue, as I am starting with kubernetes and have gone through basics, it would be great to get assigned this good first issue to start with, if this issue is open till yet.

jgao1025 commented 2 months ago

Yes, it is still open. I will assign it to you.

/assign @Nishant-k-sagar

Nishant-k-sagar commented 2 months ago

hey @jgao1025 i will complete this issue within upcoming day,

tell me any changes needed.

Nishant-k-sagar commented 2 months ago

attached image shows the updation in the code.

jgao1025 commented 2 months ago

Hi @Nishant-k-sagar,

I would think to add this in the prerequisite part too but my opinon is not very strong and I am not the member of this project. I also am not sure if installing multiple container runtimes on a local machine is a good idea.

I would suggest you to raise a PR and let a member to review it.

mlavacca commented 2 months ago

Hi @Nishant-k-sagar, this issue is about specifying in the verify section that docker is a dependency. Feel free to raise a PR with your proposed changes, then it'll be reviewed 👍

shaneutt commented 1 month ago

Not a huge deal, but just a heads up for the future: these issues need to go through triage prior to being started please (though it may be fair to say we need to make some improvements to the tooling and documentation around this).

kubernetes-sigs / gateway-api