diff options
author | 6543 <6543@obermui.de> | 2020-11-28 07:12:22 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-28 01:12:22 -0500 |
commit | e7b47c521523099826f42b166f7b562741c07834 (patch) | |
tree | 11915204151e179a47c33dc300ec727cc93fada4 /docs/content/doc/usage | |
parent | 742e21aeba5c02935269a2a3681f4486019ce542 (diff) | |
download | gitea-e7b47c521523099826f42b166f7b562741c07834.tar.gz gitea-e7b47c521523099826f42b166f7b562741c07834.zip |
Format files (#13698)
* align "make help"
* format
* untouch build/generate-svg.js
* untouch .eslintrc
* combine editorconfig's
* rm editorconfig
Co-authored-by: Lauris BH <lauris@nix.lv>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Diffstat (limited to 'docs/content/doc/usage')
-rw-r--r-- | docs/content/doc/usage/command-line.en-us.md | 6 | ||||
-rw-r--r-- | docs/content/doc/usage/email-setup.en-us.md | 4 | ||||
-rw-r--r-- | docs/content/doc/usage/git-lfs-support.md | 2 | ||||
-rw-r--r-- | docs/content/doc/usage/issue-pull-request-templates.en-us.md | 6 | ||||
-rw-r--r-- | docs/content/doc/usage/reverse-proxies.en-us.md | 4 | ||||
-rw-r--r-- | docs/content/doc/usage/template-repositories.md | 1 |
6 files changed, 11 insertions, 12 deletions
diff --git a/docs/content/doc/usage/command-line.en-us.md b/docs/content/doc/usage/command-line.en-us.md index abb6b39fa0..34ba6cdb2d 100644 --- a/docs/content/doc/usage/command-line.en-us.md +++ b/docs/content/doc/usage/command-line.en-us.md @@ -312,12 +312,12 @@ Diagnose the problems of current gitea instance according the given configuratio Currently there are a check list below: - Check if OpenSSH authorized_keys file id correct -When your gitea instance support OpenSSH, your gitea instance binary path will be written to `authorized_keys` +When your gitea instance support OpenSSH, your gitea instance binary path will be written to `authorized_keys` when there is any public key added or changed on your gitea instance. Sometimes if you moved or renamed your gitea binary when upgrade and you haven't run `Update the '.ssh/authorized_keys' file with Gitea SSH keys. (Not needed for the built-in SSH server.)` on your Admin Panel. Then all pull/push via SSH will not be work. This check will help you to check if it works well. -For contributors, if you want to add more checks, you can wrie ad new function like `func(ctx *cli.Context) ([]string, error)` and +For contributors, if you want to add more checks, you can wrie ad new function like `func(ctx *cli.Context) ([]string, error)` and append it to `doctor.go`. ```go @@ -407,7 +407,7 @@ Manage running server operations: - `--expression value`, `-e value`: Matching expression for the logger - `--prefix value`, `-p value`: Prefix for the logger - `--color`: Use color in the logs - - `--filename value`, `-f value`: Filename for the logger - + - `--filename value`, `-f value`: Filename for the logger - - `--rotate`, `-r`: Rotate logs - `--max-size value`, `-s value`: Maximum size in bytes before rotation - `--daily`, `-d`: Rotate logs daily diff --git a/docs/content/doc/usage/email-setup.en-us.md b/docs/content/doc/usage/email-setup.en-us.md index 2f46b5d6c1..9cb3a9e78c 100644 --- a/docs/content/doc/usage/email-setup.en-us.md +++ b/docs/content/doc/usage/email-setup.en-us.md @@ -17,7 +17,7 @@ menu: To use Gitea's built-in Email support, update the `app.ini` config file [mailer] section: -## Sendmail version +## Sendmail version Use the operating system’s sendmail command instead of SMTP. This is common on Linux servers. Note: For use in the official Gitea Docker image, please configure with the SMTP version. ```ini @@ -48,7 +48,7 @@ For the full list of options check the [Config Cheat Sheet]({{< relref "doc/adva - Please note: authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through: - Via the server supporting TLS through STARTTLS - usually provided on port 587. (Also known as Opportunistic TLS.) - - SMTPS connection (SMTP over transport layer security) via the default port 465. + - SMTPS connection (SMTP over transport layer security) via the default port 465. - Forced SMTPS connection with `IS_TLS_ENABLED=true`. (These are both known as Implicit TLS.) - This is due to protections imposed by the Go internal libraries against STRIPTLS attacks. diff --git a/docs/content/doc/usage/git-lfs-support.md b/docs/content/doc/usage/git-lfs-support.md index 2d5fab3cb3..7027ebf165 100644 --- a/docs/content/doc/usage/git-lfs-support.md +++ b/docs/content/doc/usage/git-lfs-support.md @@ -23,4 +23,4 @@ To use Gitea's built-in LFS support, you must update the `app.ini` file: LFS_START_SERVER = true ; Where your lfs files reside, default is data/lfs. LFS_CONTENT_PATH = /home/gitea/data/lfs -```
\ No newline at end of file +``` 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 4f5da04cb6..0bc8f0eb7c 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 @@ -17,7 +17,7 @@ menu: 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 +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 of getting some clarifying details. @@ -45,7 +45,7 @@ Additionally, the New Issue page URL can be suffixed with `?title=Issue+Title&bo # Issue Template Directory -Alternatively, users can create multiple issue templates inside a special directory and allow users to choose one that more specifically +Alternatively, users can create multiple issue templates inside a special directory and allow users to choose one that more specifically addresses their problem. Possible directory names for issue templates: @@ -74,6 +74,6 @@ This is the template! ``` In the above example, when a user is presented with the list of issues they can submit, this would show as `Template Name` with the description -`This template is for testing!`. When submitting an issue with the above example, the issue title would be pre-populated with +`This template is for testing!`. When submitting an issue with the above example, the issue title would be pre-populated with `[TEST] ` while the issue body would be pre-populated with `This is the template!`. The issue would also be assigned two labels, `bug` and `help needed`. diff --git a/docs/content/doc/usage/reverse-proxies.en-us.md b/docs/content/doc/usage/reverse-proxies.en-us.md index ac980a6ee5..1ca73c3657 100644 --- a/docs/content/doc/usage/reverse-proxies.en-us.md +++ b/docs/content/doc/usage/reverse-proxies.en-us.md @@ -45,7 +45,7 @@ server { Then set `[server] ROOT_URL = http://git.example.com/git/` in your configuration. ## Using Nginx as a reverse proxy and serve static resources directly -We can tune the performance in splitting requests into categories static and dynamic. +We can tune the performance in splitting requests into categories static and dynamic. CSS files, JavaScript files, images and web fonts are static content. The front page, a repository view or issue list is dynamic content. @@ -205,7 +205,7 @@ If you wish to run Gitea with IIS. You will need to setup IIS with URL Rewrite a - Open the IIS Manager Console and click on the `Gitea Proxy` Website from the tree view on the left. Select and double click the URL Rewrite Icon from the middle pane to load the URL Rewrite interface. - Choose the `Add Rule` action from the right pane of the management console and select the `Reverse Proxy Rule` from the `Inbound and Outbound Rules` category. - In the Inbound Rules section, set the server name to be the host that Gitea is running on with its port. e.g. if you are running Gitea on the localhost with port 3000, the following should work: `127.0.0.1:3000` - - Enable SSL Offloading + - Enable SSL Offloading - In the Outbound Rules, ensure `Rewrite the domain names of the links in HTTP response` is set and set the `From:` field as above and the `To:` to your external hostname, say: `git.example.com` - Now edit the `web.config` for your website to match the following: (changing `127.0.0.1:3000` and `git.example.com` as appropriate) diff --git a/docs/content/doc/usage/template-repositories.md b/docs/content/doc/usage/template-repositories.md index fe3fb86192..6bd5ae7bc4 100644 --- a/docs/content/doc/usage/template-repositories.md +++ b/docs/content/doc/usage/template-repositories.md @@ -69,4 +69,3 @@ Feeding `go-sdk` to the available transformers yields... | LOWER | go-sdk | | UPPER | GO-SDK | | TITLE | Go-Sdk | - |