summaryrefslogtreecommitdiffstats
path: root/docs/content/doc/usage
diff options
context:
space:
mode:
authorAidan Fitzgerald <aidan-fitz@users.noreply.github.com>2019-03-09 16:15:45 -0500
committertechknowlogick <matti@mdranta.net>2019-03-09 16:15:45 -0500
commitf5cf9a8355c46fa5619c03465178b51171ac30b9 (patch)
tree0163eb48ca238b03612176817449133cb31e34cf /docs/content/doc/usage
parent8fffb0616866cfe7a293b457d8703724666374cb (diff)
downloadgitea-f5cf9a8355c46fa5619c03465178b51171ac30b9.tar.gz
gitea-f5cf9a8355c46fa5619c03465178b51171ac30b9.zip
Copyedit docs (#6275)
Diffstat (limited to 'docs/content/doc/usage')
-rw-r--r--docs/content/doc/usage/fail2ban-setup.md6
-rw-r--r--docs/content/doc/usage/https-support.md16
-rw-r--r--docs/content/doc/usage/issue-pull-request-templates.en-us.md6
-rw-r--r--docs/content/doc/usage/pull-request.en-us.md2
-rw-r--r--docs/content/doc/usage/reverse-proxies.en-us.md14
5 files changed, 22 insertions, 22 deletions
diff --git a/docs/content/doc/usage/fail2ban-setup.md b/docs/content/doc/usage/fail2ban-setup.md
index 9fea9a640e..28c4874da2 100644
--- a/docs/content/doc/usage/fail2ban-setup.md
+++ b/docs/content/doc/usage/fail2ban-setup.md
@@ -19,7 +19,7 @@ menu:
sure to test this before relying on it so you don't lock yourself out.**
Gitea returns an HTTP 200 for bad logins in the web logs, but if you have logging options on in
-`app.ini`, then you should be able to go off of log/gitea.log, which gives you something like this
+`app.ini`, then you should be able to go off of `log/gitea.log`, which gives you something like this
on a bad authentication:
```log
@@ -52,8 +52,8 @@ action = iptables-allports
Make sure and read up on fail2ban and configure it to your needs, this bans someone
for **15 minutes** (from all ports) when they fail authentication 10 times in an hour.
-If you run Gitea behind a reverse proxy with nginx (for example with docker), you need to add
-this to your nginx configuration so that IPs don't show up as 127.0.0.1:
+If you run Gitea behind a reverse proxy with Nginx (for example with Docker), you need to add
+this to your Nginx configuration so that IPs don't show up as 127.0.0.1:
```
proxy_set_header X-Real-IP $remote_addr;
diff --git a/docs/content/doc/usage/https-support.md b/docs/content/doc/usage/https-support.md
index 25c9ab0164..531d835ff2 100644
--- a/docs/content/doc/usage/https-support.md
+++ b/docs/content/doc/usage/https-support.md
@@ -15,12 +15,12 @@ menu:
# HTTPS setup to encrypt connections to Gitea
-## Using built-in server
+ ## Using the built-in server
-Before you enable HTTPS make sure that you have valid SSL/TLS certificates.
+Before you enable HTTPS, make sure that you have valid SSL/TLS certificates.
You could use self-generated certificates for evaluation and testing. Please run `gitea cert --host [HOST]` to generate a self signed certificate.
-To use Gitea's built-in HTTPS support you must change your `app.ini` file:
+To use Gitea's built-in HTTPS support, you must change your `app.ini` file:
```ini
[server]
@@ -33,7 +33,7 @@ KEY_FILE = key.pem
To learn more about the config values, please checkout the [Config Cheat Sheet](../config-cheat-sheet#server).
-### Setting-up HTTP redirection
+### Setting up HTTP redirection
The Gitea server is only able to listen to one port; to redirect HTTP requests to the HTTPS port, you will need to enable the HTTP redirection service:
@@ -48,9 +48,9 @@ If you are using Docker, make sure that this port is configured in your `docker-
## Using Let's Encrypt
-[Let's Encrypt](https://letsencrypt.org/) is a Certificate Authority that allows you to automatically request and renew SSL/TLS certificates. In addition to starting Gitea on your configured port, to request HTTPS certificates Gitea will also need to listed on port 80, and will set up an autoredirect to HTTPS for you. Let's Encrypt will need to be able to access Gitea via the Internet to verify your ownership of the domain.
+[Let's Encrypt](https://letsencrypt.org/) is a Certificate Authority that allows you to automatically request and renew SSL/TLS certificates. In addition to starting Gitea on your configured port, to request HTTPS certificates, Gitea will also need to listed on port 80, and will set up an autoredirect to HTTPS for you. Let's Encrypt will need to be able to access Gitea via the Internet to verify your ownership of the domain.
-By using Lets Encrypt **you must consent** to their [terms of service](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf)
+By using Let's Encrypt **you must consent** to their [terms of service](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf).
```ini
[server]
@@ -66,7 +66,7 @@ To learn more about the config values, please checkout the [Config Cheat Sheet](
## Using reverse proxy
-Setup up your reverse proxy like shown in the [reverse proxy guide](../reverse-proxies).
+Setup up your reverse proxy as shown in the [reverse proxy guide](../reverse-proxies).
After that, enable HTTPS by following one of these guides:
@@ -74,5 +74,5 @@ After that, enable HTTPS by following one of these guides:
* [apache2/httpd](https://httpd.apache.org/docs/2.4/ssl/ssl_howto.html)
* [caddy](https://caddyserver.com/docs/tls)
-Note: Your connection between your reverse proxy and gitea might be unencrypted. To encrypt it too follow the [built-in server guide](#using-built-in-server) and change
+Note: Your connection between your reverse proxy and Gitea might be unencrypted. To encrypt it too, follow the [built-in server guide](#using-built-in-server) and change
the proxy url to `https://[URL]`.
diff --git a/docs/content/doc/usage/issue-pull-request-templates.en-us.md b/docs/content/doc/usage/issue-pull-request-templates.en-us.md
index e7582f3208..a4fc51b81f 100644
--- a/docs/content/doc/usage/issue-pull-request-templates.en-us.md
+++ b/docs/content/doc/usage/issue-pull-request-templates.en-us.md
@@ -15,10 +15,10 @@ menu:
# Issue and Pull Request Templates
-For some projects there are a standard list of questions that users need to be asked
-for creating an issue, or adding a pull request. Gitea supports adding templates to the
+Some projects have a standard list of questions that users need to answer
+when creating an issue or pull request. Gitea supports adding templates to the
main branch of the repository so that they can autopopulate the form when users are
-creating issues, and pull requests. This will cut down on the initial back and forth
+creating issues and pull requests. This will cut down on the initial back and forth
of getting some clarifying details.
Possible file names for issue templates:
diff --git a/docs/content/doc/usage/pull-request.en-us.md b/docs/content/doc/usage/pull-request.en-us.md
index 171c944ac0..39cff7f651 100644
--- a/docs/content/doc/usage/pull-request.en-us.md
+++ b/docs/content/doc/usage/pull-request.en-us.md
@@ -28,4 +28,4 @@ The first value of the list will be used in helpers.
## Pull Request Templates
-You can find more information about pull request templates in the dedicated page : [Issue and Pull Request templates](../issue-pull-request-templates)
+You can find more information about pull request templates at the page [Issue and Pull Request templates](../issue-pull-request-templates).
diff --git a/docs/content/doc/usage/reverse-proxies.en-us.md b/docs/content/doc/usage/reverse-proxies.en-us.md
index bd3945a405..d828d5b226 100644
--- a/docs/content/doc/usage/reverse-proxies.en-us.md
+++ b/docs/content/doc/usage/reverse-proxies.en-us.md
@@ -14,7 +14,7 @@ menu:
---
## Using Nginx as a reverse proxy
-If you want Nginx to serve your Gitea instance you can the following `server` section inside the `http` section of `nginx.conf`:
+If you want Nginx to serve your Gitea instance, you can the following `server` section inside the `http` section of `nginx.conf`:
```
server {
@@ -27,7 +27,7 @@ server {
}
```
-## Using Nginx with a Sub-path as a reverse proxy
+## Using Nginx with a sub-path as a reverse proxy
In case you already have a site, and you want Gitea to share the domain name, you can setup Nginx to serve Gitea under a sub-path by adding the following `server` section inside the `http` section of `nginx.conf`:
@@ -46,7 +46,7 @@ Then set `[server] ROOT_URL = http://git.example.com/git/` in your configuration
## Using Apache HTTPD as a reverse proxy
-If you want Apache HTTPD to serve your Gitea instance you can add the following to you Apache HTTPD configuration (usually located at `/etc/apache2/httpd.conf` in Ubuntu):
+If you want Apache HTTPD to serve your Gitea instance, you can add the following to your Apache HTTPD configuration (usually located at `/etc/apache2/httpd.conf` in Ubuntu):
```
<VirtualHost *:80>
@@ -60,7 +60,7 @@ If you want Apache HTTPD to serve your Gitea instance you can add the following
Note: The following Apache HTTPD mods must be enabled: `proxy`, `proxy_http`
-## Using Apache HTTPD with a Sub-path as a reverse proxy
+## Using Apache HTTPD with a sub-path as a reverse proxy
In case you already have a site, and you want Gitea to share the domain name, you can setup Apache HTTPD to serve Gitea under a sub-path by adding the following to you Apache HTTPD configuration (usually located at `/etc/apache2/httpd.conf` in Ubuntu):
@@ -83,7 +83,7 @@ Note: The following Apache HTTPD mods must be enabled: `proxy`, `proxy_http`
## Using Caddy as a reverse proxy
-If you want Caddy to serve your Gitea instance you can add the following server block to your Caddyfile:
+If you want Caddy to serve your Gitea instance, you can add the following server block to your Caddyfile:
```
git.example.com {
@@ -91,9 +91,9 @@ git.example.com {
}
```
-## Using Caddy with a Sub-path as a reverse proxy
+## Using Caddy with a sub-path as a reverse proxy
-In case you already have a site, and you want Gitea to share the domain name, you can setup Caddy to serve Gitea under a sub-path by adding the following to you server block in your Caddyfile:
+In case you already have a site, and you want Gitea to share the domain name, you can setup Caddy to serve Gitea under a sub-path by adding the following to your server block in your Caddyfile:
```
git.example.com {