Skip to content

Commit

Permalink
remove docs changes in releases <=1.11
Browse files Browse the repository at this point in the history
  • Loading branch information
noerw committed Jul 10, 2021
1 parent 9ed6023 commit cb6efea
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 22 deletions.
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
4 changes: 2 additions & 2 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
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
6 changes: 0 additions & 6 deletions docs/content/doc/help/faq.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,12 +277,6 @@ Please always check the release notes / [changelog](https://github.com/go-gitea/
SET GLOBAL innodb_large_prefix=1;
```

#### Why is my markdown broken

In Gitea version `1.11` we moved to [goldmark](https://github.com/yuin/goldmark) for markdown rendering, which is [CommonMark](https://commonmark.org/) compliant.
If you have markdown that worked as you expected prior to version `1.11` and after upgrading it's not working anymore, please look through the CommonMark spec to see whether the problem is due to a bug or non-compliant syntax.
If it is the latter, _usually_ there is a compliant alternative listed in the spec.
---

## Usage
Expand Down
15 changes: 11 additions & 4 deletions docs/content/doc/usage/command-line.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,17 @@ Admin operations:
- One of `--id`, `--username` or `--email` is required. If more than one is provided then all have to match.
- Examples:
- `gitea admin user delete --id 1`
- `create`: - Options: - `--name value`: Username. Required. As of gitea 1.9.0, use the `--username` flag instead. - `--username value`: Username. Required. New in gitea 1.9.0. - `--password value`: Password. Required. - `--email value`: Email. Required. - `--admin`: If provided, this makes the user an admin. Optional. - `--access-token`: If provided, an access token will be created for the user. Optional. (default: false). - `--must-change-password`: If provided, the created user will be required to choose a newer password after
the initial login. Optional. (default: true). - `--random-password`: If provided, a randomly generated password will be used as the password of
the created user. The value of `--password` will be discarded. Optional. - `--random-password-length`: If provided, it will be used to configure the length of the randomly
generated password. Optional. (default: 12) - Examples: - `gitea admin user create --username myname --password asecurepassword --email me@example.com`
- `create`:
- Options:
- `--username value`: Username. Required.
- `--password value`: Password. Required.
- `--email value`: Email. Required.
- `--admin`: If provided, this makes the user an admin. Optional.
- `--access-token`: If provided, an access token will be created for the user. Optional. (default: false).
- `--must-change-password`: If provided, the created user will be required to choose a newer password after the initial login. Optional. (default: true).
- `--random-password`: If provided, a randomly generated password will be used as the password of the created user. The value of `--password` will be discarded. Optional.
- `--random-password-length`: If provided, it will be used to configure the length of the randomly generated password. Optional. (default: 12)
- Examples: - `gitea admin user create --username myname --password asecurepassword --email me@example.com`
- `change-password`:
- Options:
- `--username value`, `-u value`: Username. Required.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/doc/usage/template-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ menu:

{{< toc >}}

Gitea `1.11.0` and above includes template repositories, and one feature implemented with them is auto-expansion of specific variables within your template files.
Gitea has template repositories, with support for auto-expansion of specific variables within your template files.
To tell Gitea which files to expand, you must include a `template` file inside the `.gitea` directory of the template repository.
Gitea uses [gobwas/glob](https://github.com/gobwas/glob) for its glob syntax. It closely resembles a traditional `.gitignore`, however there may be slight differences.

Expand Down

0 comments on commit cb6efea

Please sign in to comment.