Skip to content

Commit f5cf9a8

Browse files
Aidan Fitzgeraldtechknowlogick
authored andcommitted
Copyedit docs (#6275)
1 parent 8fffb06 commit f5cf9a8

28 files changed

+111
-111
lines changed

docs/content/doc/advanced/api-usage.en-us.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,18 @@ Gitea supports these methods of API authentication:
3131
- `access_token=...` parameter in URL query string
3232
- `Authorization: token ...` header in HTTP headers
3333

34-
All of these methods accept the same apiKey token type. You can
34+
All of these methods accept the same API key token type. You can
3535
better understand this by looking at the code -- as of this writing,
3636
Gitea parses queries and headers to find the token in
3737
[modules/auth/auth.go](https://github.com/go-gitea/gitea/blob/6efdcaed86565c91a3dc77631372a9cc45a58e89/modules/auth/auth.go#L47).
3838

39-
You can create an apiKey token via your gitea install's web interface:
39+
You can create an API key token via your Gitea installation's web interface:
4040
`Settings | Applications | Generate New Token`.
4141

4242
### More on the `Authorization:` header
4343

4444
For historical reasons, Gitea needs the word `token` included before
45-
the apiKey token in an authorization header, like this:
45+
the API key token in an authorization header, like this:
4646

4747
```
4848
Authorization: token 65eaa9c8ef52460d22a93307fe0aee76289dc675

docs/content/doc/advanced/config-cheat-sheet.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
4444

4545
- `ROOT`: **~/gitea-repositories/**: Root path for storing all repository data. It must be
4646
an absolute path.
47-
- `SCRIPT_TYPE`: **bash**: The script type this server supports, usually this is `bash`,
47+
- `SCRIPT_TYPE`: **bash**: The script type this server supports. Usually this is `bash`,
4848
but some users report that only `sh` is available.
4949
- `ANSI_CHARSET`: **\<empty\>**: The default charset for an unrecognized charset.
5050
- `FORCE_PRIVATE`: **false**: Force every new repository to be private.

docs/content/doc/advanced/customizing-gitea.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ menu:
1818
Customizing Gitea is typically done using the `custom` folder. This is the central
1919
place to override configuration settings, templates, etc.
2020

21-
If Gitea is deployed from binary, all default paths will be relative to the gitea
21+
If Gitea is deployed from binary, all default paths will be relative to the Gitea
2222
binary. If installed from a distribution, these paths will likely be modified to
2323
the Linux Filesystem Standard. Gitea will create required folders, including `custom/`.
2424
Application settings are configured in `custom/conf/app.ini`. Distributions may

docs/content/doc/advanced/external-renderers.en-us.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ menu:
1616
# Custom files rendering configuration
1717

1818
Gitea supports custom file renderings (i.e., Jupyter notebooks, asciidoc, etc.) through external binaries,
19-
it is just matter of:
19+
it is just a matter of:
2020
* installing external binaries
2121
* add some configuration to your `app.ini` file
22-
* restart your gitea instance
22+
* restart your Gitea instance
2323

2424
## Installing external binaries
2525

docs/content/doc/advanced/hacking-on-gitea.en-us.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,24 @@ necessary. To be able to use these you must have the `"$GOPATH"/bin` directory
3232
on the executable path. If you don't add the go bin directory to the
3333
executable path you will have to manage this yourself.
3434

35-
**Note 2**: Go version 1.9 or higher is required, however it is important
35+
**Note 2**: Go version 1.9 or higher is required; however, it is important
3636
to note that our continuous integration will check that the formatting of the
3737
source code is not changed by `gofmt` using `make fmt-check`. Unfortunately,
38-
the results of `gofmt` can differ by the version of `go` it is therefore
38+
the results of `gofmt` can differ by the version of `go`. It is therefore
3939
recommended to install the version of go that our continuous integration is
40-
running. At the time of writing this is Go version 1.11, however this can be
40+
running. At the time of writing this is Go version 1.12; however, this can be
4141
checked by looking at the
4242
[master `.drone.yml`](https://github.com/go-gitea/gitea/blob/master/.drone.yml)
4343
(At the time of writing
4444
[line 67](https://github.com/go-gitea/gitea/blob/8917d66571a95f3da232a0c27bc1300210d10fde/.drone.yml#L67)
45-
is the relevant line - however this may change.)
45+
is the relevant line - but this may change.)
4646

4747
## Downloading and cloning the Gitea source code
4848

4949
Go is quite opinionated about where it expects its source code, and simply
5050
cloning the Gitea repository to an arbitrary path is likely to lead to
51-
problems - the fixing of which is out of scope for this document. Further some
52-
internal packages are referenced using their respective Github URL and at
51+
problems - the fixing of which is out of scope for this document. Further, some
52+
internal packages are referenced using their respective GitHub URL and at
5353
present we use `vendor/` directories.
5454

5555
The recommended method of obtaining the source code is by using the `go get` command:
@@ -65,7 +65,7 @@ is not set `"$HOME/go/src/code.gitea.io/gitea"`.
6565
## Forking Gitea
6666

6767
As stated above, you cannot clone Gitea to an arbitrary path. Download the master Gitea source
68-
code as above. Then fork the [Gitea repository](https://github.com/go-gitea/gitea) on GitHub,
68+
code as above. Then, fork the [Gitea repository](https://github.com/go-gitea/gitea) on GitHub,
6969
and either switch the git remote origin for your fork or add your fork as another remote:
7070

7171
```bash
@@ -86,7 +86,7 @@ git fetch --all --prune
8686
```
8787

8888
To be able to create pull requests, the forked repository should be added as a remote
89-
to the Gitea sources, otherwise changes can't be pushed.
89+
to the Gitea sources. Otherwise, changes can't be pushed.
9090

9191
## Building Gitea (Basic)
9292

@@ -141,10 +141,10 @@ make vet lint misspell-check
141141
To generate the stylsheets, you will need [Node.js](https://nodejs.org/) at version 8.0 or above.
142142

143143
At present we use [less](http://lesscss.org/) and [postcss](https://postcss.org) to generate our stylesheets. Do
144-
**not** edit the files in `public/css/` directly as they are generated from
144+
**not** edit the files in `public/css/` directly, as they are generated from
145145
`lessc` from the files in `public/less/`.
146146

147-
If you wish to work on the stylesheets you will need to install `lessc` the
147+
If you wish to work on the stylesheets, you will need to install `lessc` the
148148
less compiler and `postcss`. The recommended way to do this is using `npm install`:
149149

150150
```bash
@@ -163,17 +163,17 @@ PRs.
163163

164164
### Updating the API
165165

166-
When creating new API routes or modifying existing API routes you **MUST**
166+
When creating new API routes or modifying existing API routes, you **MUST**
167167
update and/or create [Swagger](https://swagger.io/docs/specification/2-0/what-is-swagger/)
168168
documentation for these using [go-swagger](https://goswagger.io/) comments.
169169
The structure of these comments is described in the [specification](https://goswagger.io/use/spec.html#annotation-syntax).
170-
If you want more information about the Swagger structure you can look at the
170+
If you want more information about the Swagger structure, you can look at the
171171
[Swagger 2.0 Documentation](https://swagger.io/docs/specification/2-0/basic-structure/)
172-
or compare with a previous PR adding a new API endpoint e.g. [PR #5483](https://github.com/go-gitea/gitea/pull/5843/files#diff-2e0a7b644cf31e1c8ef7d76b444fe3aaR20)
172+
or compare with a previous PR adding a new API endpoint, e.g. [PR #5483](https://github.com/go-gitea/gitea/pull/5843/files#diff-2e0a7b644cf31e1c8ef7d76b444fe3aaR20)
173173

174174
You should be careful not to break the API for downstream users which depend
175-
on a stable API. In general this means additions are acceptable, but deletions
176-
or fundamental changes of API will be rejected.
175+
on a stable API. In general, this means additions are acceptable, but deletions
176+
or fundamental changes to the API will be rejected.
177177

178178
Once you have created or changed an API endpoint, please regenerate the Swagger
179179
documentation using:
@@ -208,7 +208,7 @@ found in `docs/content/doc/advanced/config-cheat-sheet.en-us.md`
208208

209209
### Changing the logo
210210

211-
When changing the Gitea logo svg. You will need to run and commit the results
211+
When changing the Gitea logo SVG, you will need to run and commit the results
212212
of:
213213

214214
```bash
@@ -220,7 +220,7 @@ This will create the necessary Gitea favicon and others.
220220
### Database Migrations
221221

222222
If you make breaking changes to any of the database persisted structs in the
223-
`models/` directory you will need to make a new migration. These can be found
223+
`models/` directory, you will need to make a new migration. These can be found
224224
in `models/migrations/`. You can ensure that your migrations work for the main
225225
database types using:
226226

@@ -236,23 +236,23 @@ There are two types of test run by Gitea: Unit tests and Integration Tests.
236236
TAGS="bindata sqlite sqlite_unlock_notify" make test # Runs the unit tests
237237
```
238238

239-
Unit tests will not and cannot completely test Gitea alone. Therefore we
240-
have written integration tests, however, these are database dependent.
239+
Unit tests will not and cannot completely test Gitea alone. Therefore, we
240+
have written integration tests; however, these are database dependent.
241241

242242
```bash
243243
TAGS="bindata sqlite sqlite_unlock_notify" make generate build test-sqlite
244244
```
245245

246-
Will run the integration tests in an sqlite environment. Other database tests
247-
are available however may need adjustment for local environment.
246+
will run the integration tests in an sqlite environment. Other database tests
247+
are available but may need adjustment to the local environment.
248248

249249
Look at
250250
[`integrations/README.md`](https://github.com/go-gitea/gitea/blob/master/integrations/README.md)
251251
for more information and how to run a single test.
252252

253253
Our continuous integration will test the code passes its unit tests and that
254-
all supported databases will pass integration test in a docker environment.
255-
Migration from several recent versions of gitea will also be tested.
254+
all supported databases will pass integration test in a Docker environment.
255+
Migration from several recent versions of Gitea will also be tested.
256256

257257
Please submit your PR with additional tests and integration tests as
258258
appropriate.
@@ -268,7 +268,7 @@ make trans-copy clean build
268268
```
269269

270270
You will require a copy of [Hugo](https://gohugo.io/) to run this task. Please
271-
note this may generate a number of untracked git objects which will need to
271+
note: this may generate a number of untracked git objects, which will need to
272272
be cleaned up.
273273

274274
## Visual Studio Code

docs/content/doc/advanced/specific-variables.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ For documentation about each of the variables available, refer to the
5959
* `HOST`: Host Macaron will listen on
6060
* `PORT`: Port Macaron will listen on
6161
* `MACARON_ENV`: global variable to provide special functionality for development environments
62-
vs. production environments. If MACARON_ENV is set to "" or "development" then templates will
62+
vs. production environments. If MACARON_ENV is set to "" or "development", then templates will
6363
be recompiled on every request. For more performance, set the MACARON_ENV environment variable
6464
to "production".
6565

docs/content/doc/features/authentication.en-us.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Both the LDAP via BindDN and the simple auth LDAP share the following fields:
9191
name given on sign-in form.
9292
- Example: `(&(objectClass=posixAccount)(uid=%s))`
9393
- Example for Microsoft Active Directory (AD): `(&(objectCategory=Person)(memberOf=CN=user-group,OU=example,DC=example,DC=org)(sAMAccountName=%s)(!(UserAccountControl:1.2.840.113556.1.4.803:=2)))`
94-
- To substitute more than once `%[1]s` should be used instead, e.g. when
94+
- To substitute more than once, `%[1]s` should be used instead, e.g. when
9595
matching supplied login name against multiple attributes such as user
9696
identifier, email or even phone number.
9797
- Example: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))`
@@ -181,7 +181,7 @@ configure this, set the fields below:
181181

182182
## FreeIPA
183183

184-
- In order to log in to Gitea using FreeIPA credentials,a bind account needs to
184+
- In order to log in to Gitea using FreeIPA credentials, a bind account needs to
185185
be created for Gitea:
186186

187187
- On the FreeIPA server, create a `gitea.ldif` file, replacing `dc=example,dc=com`

docs/content/doc/features/comparison.en-us.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ menu:
1515

1616
# Gitea compared to other Git hosting options
1717

18-
To help decide if Gitea is suited for your needs here is how it compares to other Git self hosted options.
18+
To help decide if Gitea is suited for your needs, here is how it compares to other Git self hosted options.
1919

20-
Be warned that we don't regularly check for feature changes in other products so this list can be outdated. If you find anything that needs to be updated in table below please report [issue on Github](https://github.com/go-gitea/gitea/issues).
20+
Be warned that we don't regularly check for feature changes in other products, so this list may be outdated. If you find anything that needs to be updated in the table below, please report it in an [issue on GitHub](https://github.com/go-gitea/gitea/issues).
2121

2222
_Symbols used in table:_
2323

@@ -118,7 +118,7 @@ _Symbols used in table:_
118118
| LDAP user synchronization ||||||||
119119
| OpenId Connect support |||||| ? ||
120120
| OAuth 2.0 integration (external authorization) |||||| ? ||
121-
| Act as OAuth 2.0 provider | |||||||
121+
| Act as OAuth 2.0 provider | [](https://github.com/go-gitea/gitea/pull/5378) |||||||
122122
| Two factor authentication (2FA) ||||||||
123123
| Mattermost/Slack integration ||||||||
124124
| Discord integration ||||||||

docs/content/doc/features/webhooks.en-us.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ menu:
1515

1616
# Webhooks
1717

18-
Gitea supports web hooks for repository events, this can be found in the settings
19-
page(`/:username/:reponame/settings/hooks`). All event pushes are POST requests.
18+
Gitea supports web hooks for repository events. This can be found in the settings
19+
page `/:username/:reponame/settings/hooks`. All event pushes are POST requests.
2020
The two methods currently supported are Gitea and Slack.
2121

2222
### Event information
@@ -26,8 +26,8 @@ a Payload URL:
2626

2727

2828
```
29-
X-Github-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473
30-
X-Github-Event: push
29+
X-GitHub-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473
30+
X-GitHub-Event: push
3131
X-Gogs-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473
3232
X-Gogs-Event: push
3333
X-Gitea-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473

docs/content/doc/help/seek-help.en-us.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ menu:
2020

2121
## Bugs
2222

23-
If you found a bug, please create an [issue on Github](https://github.com/go-gitea/gitea/issues).
23+
If you found a bug, please create an [issue on GitHub](https://github.com/go-gitea/gitea/issues).
2424

2525
## Chinese Support
2626

0 commit comments

Comments
 (0)