diff options
author | Rémy Coutable <remy@rymai.me> | 2018-04-09 17:24:06 +0300 |
---|---|---|
committer | Rémy Coutable <remy@rymai.me> | 2018-04-09 17:24:06 +0300 |
commit | 6191e37dd59b8d1b8531c8d1d6aa4dcb2a360302 (patch) | |
tree | 7ba95ed6291c60ff9a405a1c688712f5747ed755 | |
parent | 35e35787667c87232bb956945525932d921f978e (diff) |
Fix a few typos in doc/ruby_endpoint.md
-rw-r--r-- | doc/ruby_endpoint.md | 41 |
1 files changed, 21 insertions, 20 deletions
diff --git a/doc/ruby_endpoint.md b/doc/ruby_endpoint.md index 147317fa9..ea2610059 100644 --- a/doc/ruby_endpoint.md +++ b/doc/ruby_endpoint.md @@ -4,21 +4,21 @@ #### GitLab -Before you can develop on Gitaly, its required to have a +Before you can develop on Gitaly, it's required to have a [GitLab Development Kit][gdk] properly installed. After installing GitLab, verify it to be working by starting the required servers and visiting GitLab on `http://localhost:3000`. #### Go -For the GitLab development Kit to run, both Ruby and Golang are installed. -The last step required for golang development, is the setup of a workspace. +For the GitLab Development Kit to run, both Ruby and Golang are installed. +The last step required for Golang development, is the setup of a workspace. Please consult the [official documentation][go-workspace] on this topic. #### Gitaly Proto -GitLab will want to read and manipulate git data, to do this it needs to talk -to Gitaly. For GitLab and Gitaly its important to have a set protocol. This +GitLab will want to read and manipulate Git data, to do this it needs to talk +to Gitaly. For GitLab and Gitaly it's important to have a set protocol. This protocol defines what requests can be made and what data the requester has to send with the request. For each request the response is defined too. @@ -30,14 +30,15 @@ fork the [Gitaly Proto project][gitaly-proto]. Afterward your can run: # Create the needed directory $ mkdir -p $GOPATH/src/gitlab.com/<your-username> $ cd $GOPATH/src/gitlab.com/<your-username> -$ git clone https://gitlab.com/<your-username/gitaly-proto.git +$ git clone https://gitlab.com/<your-username>/gitaly-proto.git ``` + #### Gitaly -Gitaly is a component that calls procedure on the git data when its requested +Gitaly is a component that calls procedure on the Git data when it's requested to do so. Gitaly is bundled in the [GDK][gdk], but for development purposes another copy can be stored in the `$GOPATH`. First you can fork the -[Gitaly project][gitaly] project. Than you can run: +[Gitaly project][gitaly] project. Then you can run: ```bash $ cd $GOPATH/src/gitlab.com/<your-username> @@ -45,7 +46,7 @@ $ git clone gitlab.com/<your-username>/gitaly.git ``` To verify your install, please change your directory to -`$GOPATH/src/gitlab.com/<your-username>/gitaly` and run `make`. And afterwards +`$GOPATH/src/gitlab.com/<your-username>/gitaly`, run `make`, and afterwards `make test`. Again, if any errors occur, please [open an issue][gitaly-issue]. ### Development @@ -55,7 +56,7 @@ To verify your install, please change your directory to In general there are a couple of stages to go through, in order: 1. Add a request/response combination to [Gitaly Proto][gitaly-proto], or edit an existing one -1. Change [Gitaly][gitaly] accourdingly +1. Change [Gitaly][gitaly] accordingly 1. Use the endpoint in other GitLab components (CE/EE, GitLab Workhorse, etc.) ##### Gitaly Proto @@ -63,12 +64,12 @@ In general there are a couple of stages to go through, in order: The [Protocol buffer documentation][proto-docs] combined with the `*.proto` files should be enough to get you started. A service needs to be picked that can receive the procedure call. A general rule of thumb is that the service is named -either after the git cli command, or after the git object type. +either after the Git CLI command, or after the Git object type. -If either your request of response data will exceed 1MB you need to use the +If either your request or response data will exceed 1MB you need to use the `stream` keyword. To generate the server and client code, run `make`. If this succeeds without any errors, create a feature branch to commit your changes to. -Than create a merge request and wait for a review. +Then create a merge request and wait for a review. ##### Gitaly @@ -94,9 +95,9 @@ doesn't yet have the new endpoint implemented. ###### Go boilerplate -To create the Ruby endpoint, some go is required as the go code receives the -requests and reroutes it to the go server. In general this is boilerplate code -where only method- and variable names are different. +To create the Ruby endpoint, some Go is required as the go code receives the +requests and reroutes it to the Go server. In general this is boilerplate code +where only method and variable names are different. Examples: - Simple: [Simple request in, simple response out](https://gitlab.com/gitlab-org/gitaly/blob/6841327adea214666417ee339ca37b58b20c649c/internal/service/wiki/delete_page.go) @@ -106,25 +107,25 @@ Examples: ###### Ruby -The ruby code needs to added to `ruby/lib/gitaly_server/<service-name>_service.rb`. +The Ruby code needs to be added to `ruby/lib/gitaly_server/<service-name>_service.rb`. The method name should match the name defined by the `gitaly-proto` gem. To be sure run `bundle open gitaly-proto`. The return value of the method should be an instance of the response object. Finally, to test it manually using the GitLab Development Kit, GitLab must be told -to use the new Gitaly. First run `make` to compile the project. Than go to the +to use the new Gitaly. First run `make` to compile the project. Then go to the `gitlab` directory in your GDK and follow the [instructions on using a custom Gitaly][custom-gitaly]. ### Testing -Tests can be written in Ruby with Rspec. These can be found in `ruby/spec/`. These tests are +Tests can be written in Ruby with RSpec. These can be found in `ruby/spec/`. These tests are end to end tests, so the Go code is tested too. [custom-gitaly]: https://docs.gitlab.com/ee/development/gitaly.html#running-tests-with-a-locally-modified-version-of-gitaly [gdk]: https://gitlab.com/gitlab-org/gitlab-development-kit/#getting-started [git-remote]: https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes [gitaly]: https://gitlab.com/gitlab-org/gitaly -[gitaly]: https://gitlab.com/gitlab-org/gitaly/issues +[gitaly-issue]: https://gitlab.com/gitlab-org/gitaly/issues [gitaly-proto]: https://gitlab.com/gitlab-org/gitaly-proto [gitaly-proto-issue]: https://gitlab.com/gitlab-org/gitaly-proto/issues [gitlab]: https://gitlab.com |