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

docs: improve development doc #4017

Open
mahdikhashan opened this issue Feb 18, 2025 · 1 comment · May be fixed by #4018
Open

docs: improve development doc #4017

mahdikhashan opened this issue Feb 18, 2025 · 1 comment · May be fixed by #4018
Assignees

Comments

@mahdikhashan
Copy link
Contributor

while reading the development.md file in docs, I noticed a few typos and structural mistakes, I'd like to open a pr and improve this file, since it will benefit contributors like me.

➜  volcano git:(typo-in-development) ✗ diff new-dev.md docs/development/development.md
1c1,3
< This document helps you get started using the Volcano code base. If you follow this guide and find a problem, please take a few minutes to update this file.
---
> This document helps you get started using the Volcano code base.
> If you follow this guide and find some problem, please take
> a few minutes to update this file.
14d15
< ## Cloning the Code
16c17
< You will need to clone the main `volcano` repo to `$GOPATH/src/volcano.sh/volcano` for the below commands to work correctly.
---
> ## Cloning the code
18c19,20
< ## Building the Code
---
> You will need to clone the main `volcano` repo to `$GOPATH/src/volcano.sh/volcano` for
> the below commands to work correctly.
20c22
< To build all Volcano components for your host architecture, go to the source root and run:
---
> ## Building the code
21a24,26
> To build volcano all components for your host architecture, go to
> the source root and run:
>
24a30,31
> the binaries will be generated at .../src/volcano.sh/volcano/_output/bin/linux/amd64/
> but if we just make as below
26,29d32
< The binaries will be generated at `.../src/volcano.sh/volcano/_output/bin/linux/amd64/`.
<
< If we just run `make` as below:
<
32a36
> then the binaries would be generated at .../src/volcano.sh/volcano/_output/bin/
34c38,39
< Then the binaries would be generated at `.../src/volcano.sh/volcano/_output/bin/`.
---
> To build a specific component for your host architecture, go to
> the source root and run `make <component name>`:
36,37d40
< To build a specific component for your host architecture, go to the source root and run `make <component name>`:
<
42d44
< ## Building Docker Images
44c46
< Build the containers in your local Docker cache:
---
> ## Building docker images
45a48,49
> Build the containers in your local docker cache:
>
56d59
< ## Building a Specific Component
58c61
< If you want to make a local change and test some component, say `vc-controller-manager`, you could do:
---
> ## Building a specific component
60c63,64
< Under `volcano.sh/volcano` repo:
---
> If you want to make a local change and test some component, say `vc-controller-manager`, you
> could do:
61a66,67
> Under volcano.sh/volcano repo
>
64a71
> The path should be
66,67d72
< The path should be:
<
72,73c77
< Set up environment variables HUB and TAG:
<
---
> Set up environment variables HUB and TAG by
79c83
< Make some local change to the code, then build `vc-controller-manager`:
---
> Make some local change of the code, then build `vc-controller-manager`
85c89
< ## Building the Volcano Manifests
---
> ## Building the Volcano manifests
87c91
< Use the following command to build the deploy YAML files:
---
> Use the following command to build the deploy yaml files:
93c97
< ## Cleaning Outputs
---
> ## Cleaning outputs
101c105
< ## Running Tests
---
> ## Running tests
103c107
< ### Running Unit Tests
---
> ### Running unit tests
111c115
< ### Running E2E Tests
---
> ### Running e2e tests
121c125
< If you want to run e2e tests in an existing cluster with Volcano deployed, run the following:
---
> If you want to run e2e test in a existing cluster with volcano deployed, run the following:
124c128
< export VC_BIN=<path-to-vcctl-binary> (e.g., .../src/volcano.sh/volcano/_output/bin/)
---
> export VC_BIN= need to set vcctl binary path (eg:.../src/volcano.sh/volcano/_output/bin/)
128c132
< ## Auto-Formatting Source Code
---
> ## Auto-formatting source code
130c134,135
< You can automatically format the source code to follow our conventions by going to the top of the repo and entering:
---
> You can automatically format the source code to follow our conventions by going to the
> top of the repo and entering:
136c141
< ## Running the Verification
---
> ## Running the verification
144c149
< ## Adding Dependencies
---
> ## Adding dependencies
146c151,152
< Volcano uses [Go Modules](https://blog.golang.org/migrating-to-go-modules) to manage its dependencies. If you want to add or update a dependency, run:
---
> Volcano uses [Go Modules](https://blog.golang.org/migrating-to-go-modules) to manage its dependencies.
> If you want to add or update a dependency, running:
154c160,161
< Note: Go's module system, introduced in Go 1.11, provides an official dependency management solution built into the `go` command. Make sure `GO111MODULE` env is not `off` before using it.
---
> Note: Go's module system, introduced in Go 1.11, provides an official dependency management solution built into the go command.
>       Make sure `GO111MODULE` env is not `off` before using it.
156c163
< ## About Testing
---
> ## About testing
158c165,167
< Before sending pull requests, you should at least make sure your changes have passed both unit tests and verification. We only merge pull requests when **all** tests are passing.
---
> Before sending pull requests you should at least make sure your changes have
> passed both unit and the verification. We only merge pull requests when
> **all** tests are passing.
164c173,174
< - The preferred method of testing multiple scenarios or input is [table-driven testing](https://github.com/golang/go/wiki/TableDrivenTests).
---
> - The preferred method of testing multiple scenarios or input is
>   [table driven testing](https://github.com/golang/go/wiki/TableDrivenTests)
166,167d175
<
<
@mahdikhashan
Copy link
Contributor Author

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant