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

revamp docs: improved discoverability of common help topics #16392

Closed
wants to merge 14 commits into from
2 changes: 0 additions & 2 deletions docs/content/doc/advanced/cmd-embedded.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@ inside the `custom` directory (see [Customizing Gitea]({{< relref "doc/advanced/
To obtain a copy of the embedded resources ready for editing, the `embedded` command from the CLI
can be used from the OS shell interface.

**NOTE:** The embedded data extraction tool is included in Gitea versions 1.12 and above.

## Listing resources

To list resources embedded in Gitea's executable, use the following syntax:
Expand Down
6 changes: 3 additions & 3 deletions docs/content/doc/advanced/config-cheat-sheet.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,8 @@ The following configuration set `Content-Type: application/vnd.android.package-a

- `OFFLINE_MODE`: **false**: Disables use of CDN for static files and Gravatar for profile pictures.
- `DISABLE_ROUTER_LOG`: **false**: Mute printing of the router log.
- `CERT_FILE`: **https/cert.pem**: Cert file path used for HTTPS. When chaining, the server certificate must come first, then intermediate CA certificates (if any). From 1.11 paths are relative to `CUSTOM_PATH`.
- `KEY_FILE`: **https/key.pem**: Key file path used for HTTPS. From 1.11 paths are relative to `CUSTOM_PATH`.
- `CERT_FILE`: **https/cert.pem**: Cert file path used for HTTPS. When chaining, the server certificate must come first, then intermediate CA certificates (if any).
- `KEY_FILE`: **https/key.pem**: Key file path used for HTTPS.
- `STATIC_ROOT_PATH`: **./**: Upper level of template and static files path.
- `APP_DATA_PATH`: **data** (**/data/gitea** on docker): Default path for application data.
- `STATIC_CACHE_TIME`: **6h**: Web browser cache time for static resources on `custom/`, `public/` and all uploaded avatars. Note that this cache is disabled when `RUN_MODE` is "dev".
Expand Down Expand Up @@ -444,7 +444,7 @@ relation to port exhaustion.
## OpenID (`openid`)

- `ENABLE_OPENID_SIGNIN`: **false**: Allow authentication in via OpenID.
- `ENABLE_OPENID_SIGNUP`: **! DISABLE\_REGISTRATION**: Allow registering via OpenID.
- `ENABLE_OPENID_SIGNUP`: **! DISABLE\_REGISTRATION && ENABLE\_OPENID\_SIGNIN**: Allow registering via OpenID.
- `WHITELISTED_URIS`: **\<empty\>**: If non-empty, list of POSIX regex patterns matching
OpenID URI's to permit.
- `BLACKLISTED_URIS`: **\<empty\>**: If non-empty, list of POSIX regex patterns matching
Expand Down
18 changes: 15 additions & 3 deletions docs/content/doc/advanced/customizing-gitea.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ You can display STL file directly in Gitea by adding:

to the file `templates/custom/footer.tmpl`

You also need to download the content of the library [Madeleine.js](https://jinjunho.github.io/Madeleine.js/) and place it under `$GITEA_CUSTOM/public/` folder.
You also need to download the content of the library [Madeleine.js](https://github.com/beige90/Madeleine.js) and place it under `$GITEA_CUSTOM/public/` folder.

You should end-up with a folder structucture similar to:

Expand Down Expand Up @@ -321,8 +321,20 @@ A full list of supported emoji's is at [emoji list](https://gitea.com/gitea/gite

## Customizing the look of Gitea

As of version 1.6.0 Gitea has built-in themes. The two built-in themes are, the default theme `gitea`, and a dark theme `arc-green`. To change the look of your Gitea install change the value of `DEFAULT_THEME` in the [ui](https://docs.gitea.io/en-us/config-cheat-sheet/#ui-ui) section of `app.ini` to another one of the available options.
As of version 1.8.0 Gitea also has per-user themes. The list of themes a user can choose from can be configured with the `THEMES` value in the [ui](https://docs.gitea.io/en-us/config-cheat-sheet/#ui-ui) section of `app.ini` (defaults to `gitea` and `arc-green`, light and dark respectively)
Gitea has two built-in themes, `gitea` (light) and `arc-green` (dark).
More themes are available, see [awesome-gitea](https://gitea.com/gitea/awesome-gitea#user-content-themes).

- To change the default theme, change the value of `DEFAULT_THEME` in the [ui]({{< relref "doc/advanced/config-cheat-sheet.en-us.md" >}}#ui-ui) section of `app.ini` to one of the available options.

- To make a theme selectable by users in their profile settings, add its name to the list of `THEMES` in your `app.ini`.

- To add a custom theme:
Currently the only way is to provide a complete theme (not just color overrides).

As an example, let's say our theme is [`arc-blue`](https://gitea.artixlinux.org/artix/gitea-dark-blue).
Download the `.css` file and name it `theme-arc-blue.css`, and add it to your custom folder in `$GITEA_CUSTOM/public/css/`.

Adapt your `app.ini` to make it the default theme or be user-selectable, as described above.

## Customizing fonts

Expand Down
4 changes: 1 addition & 3 deletions docs/content/doc/advanced/logging-documentation.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ menu:

# Logging Configuration

The logging framework has been revamped in Gitea 1.9.0.

**Table of Contents**

{{< toc >}}
Expand Down Expand Up @@ -94,7 +92,7 @@ log using the value: `ROUTER = ,`

### The "Access" logger

The Access logger is a new logger for version 1.9. It provides a NCSA
The Access logger provides a NCSA
Common Log compliant log format. It's highly configurable but caution
should be taken when changing its template. The main benefit of this
logger is that Gitea can now log accesses in a standard log format so
Expand Down
6 changes: 3 additions & 3 deletions docs/content/doc/developers/migrations.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ menu:

# Migration Features

Complete migrations were introduced in Gitea 1.9.0. It defines two interfaces to support migrating
Currently, migrations from GitHub, Gitlab, Gogs, and other Gitea instances are implemented.
Gitea's migration feature defines two interfaces to support migrating
repository data from other git host platforms to Gitea or, in the future, migrating Gitea data to other
git host platforms.
Currently, migrations from Github, Gitlab, and other Gitea instances are implemented.
git host platforms.

First of all, Gitea defines some standard objects in packages [modules/migrations/base](https://github.com/go-gitea/gitea/tree/main/modules/migrations/base).
They are `Repository`, `Milestone`, `Release`, `ReleaseAsset`, `Label`, `Issue`, `Comment`, `PullRequest`, `Reaction`, `Review`, `ReviewComment`.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/doc/developers/oauth2-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ menu:

{{< toc >}}

Gitea supports acting as an OAuth2 provider to allow third party applications to access its resources with the user's consent. This feature is available since release 1.8.0.
Gitea supports acting as an OAuth2 provider to allow third party applications to access its resources with the user's consent.

## Endpoints

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ toc: false
draft: false
menu:
sidebar:
parent: "developers"
parent: "features"
name: "Integrations"
weight: 65
identifier: "integrations"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ toc: false
draft: false
menu:
sidebar:
parent: "developers"
parent: "features"
name: "整合"
weight: 65
identifier: "integrations"
Expand Down
Loading