Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jgao1025 opened this issue Aug 13, 2024 · 10 comments
Open
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.

Comments

@jgao1025
Copy link
Contributor

jgao1025 commented Aug 13, 2024

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

No tasks being tracked yet.
@jgao1025
Copy link
Contributor Author

/kind documentation

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 13, 2024
@jgao1025
Copy link
Contributor Author

/good-first-issue
/help

@k8s-ci-robot
Copy link
Contributor

@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:

/good-first-issue
/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Aug 13, 2024
@Nishant-k-sagar
Copy link

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
Copy link
Contributor Author

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

/assign @Nishant-k-sagar

@Nishant-k-sagar
Copy link

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

tell me any changes needed.

@Nishant-k-sagar
Copy link

attached image shows the updation in the code.

@jgao1025
Copy link
Contributor Author

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
Copy link
Member

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
Copy link
Member

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

5 participants