diff --git a/docs/admin/reverse-proxy.md b/docs/admin/reverse-proxy.md index 2d153948..34aae104 100644 --- a/docs/admin/reverse-proxy.md +++ b/docs/admin/reverse-proxy.md @@ -100,7 +100,7 @@ You may wish to change the `ROOT_URL` configuration key to the HTTPS protocol so #### HTTPS with manually installed certificates -If you have obtained certificates from elsewhere or have chosen not to let CYou'ertbot automatically install them, make the following changes to the configuration file: +If you have obtained certificates from elsewhere or have chosen not to let Certbot automatically install them, make the following changes to the configuration file: **Change the listening ports** diff --git a/docs/user/agit-support.md b/docs/user/agit-support.md index 0eaf0661..c2a7bb19 100644 --- a/docs/user/agit-support.md +++ b/docs/user/agit-support.md @@ -76,9 +76,14 @@ git push origin local-branch:refs/for/remote-branch/topic ### Parameters +```sh +git push :refs/for[draft|for-review]// [-o ] +``` + The following parameters are available: -- `HEAD`: The local reference being pushed (e.g., `HEAD`, `my-branch`, a commit hash) **(required)** +- ``: The name of the remote repository (e.g., `origin`) **(required)** +- ``: The local reference being pushed (e.g., `HEAD`, `my-branch`, a commit hash) **(required)** - `refs///`: Refspec **(required)** - `for`/`draft`/`for-review`: This parameter describes the Pull Request type. **for** opens a normal Pull Request. **draft** and **for-review** are currently silently ignored. - ``: The target branch that a Pull Request should be merged against **(required)** diff --git a/docs/user/blocking-user.md b/docs/user/blocking-user.md index c36ee657..36da96a1 100644 --- a/docs/user/blocking-user.md +++ b/docs/user/blocking-user.md @@ -1,5 +1,5 @@ --- -title: Blocking a User +title: Blocking a user license: 'CC-BY-SA-4.0' --- diff --git a/docs/user/labels.md b/docs/user/labels.md index e221aa25..e60c3aeb 100644 --- a/docs/user/labels.md +++ b/docs/user/labels.md @@ -20,7 +20,7 @@ From the labels management page, click on the `New Label` button. ![create a label](../_images/user/labels/label-new.png) -Labels have a mandatory name, a mandatory color, an optional description, and must either be exclusive or not (see `Scoped Labels` below). +Labels have a mandatory name, a mandatory color, an optional description, and must either be exclusive or not (see [Scoped Labels](#scoped-labels) below). When you create a repository (or an organization), you can ensure certain labels exist by using the `Issue Labels` option. This option lists a number of available label sets that are configured globally on your instance. diff --git a/docs/user/linked-references.md b/docs/user/linked-references.md index 7029bd23..638974ea 100644 --- a/docs/user/linked-references.md +++ b/docs/user/linked-references.md @@ -173,8 +173,8 @@ the `!` marker to identify pull requests. For example: > This is pull request [!1234](#), and links to a pull request in Forgejo. The `!` and `#` can be used interchangeably for issues and pull requests _except_ -for this case, where a distinction is required. If the repository uses an external -tracker, the commit message for a squash merge will use `!` as a reference by default. +for the case, where a distinction is required. If the repository uses an external +tracker, the commit message for a squash merge will use `!` as a reference marker by default. ## Issues and Pull Requests References Summary diff --git a/docs/user/merge-message-templates.md b/docs/user/merge-message-templates.md index 5e321fb4..272a3077 100644 --- a/docs/user/merge-message-templates.md +++ b/docs/user/merge-message-templates.md @@ -32,7 +32,7 @@ You can use the following variables enclosed in `${}` inside these templates, wh - PullRequestPosterName: Pull request's poster name - PullRequestIndex: Pull request's index number - PullRequestReference: Pull request's reference character with index number, i.e., #1, !2 -- ClosingIssues: Returns a string containing all issues that will be closed by this pull request, i.e., `close #1, close #2` +- ClosingIssues: A string containing all issues that will be closed by this pull request, i.e., `close #1, close #2` ## Rebase diff --git a/docs/user/pull-requests-and-git-flow.md b/docs/user/pull-requests-and-git-flow.md index 445add73..bc68dc5f 100644 --- a/docs/user/pull-requests-and-git-flow.md +++ b/docs/user/pull-requests-and-git-flow.md @@ -53,7 +53,7 @@ This button is automatically shown if: - You are the pusher on a branch that still exists and that is not the default branch. - The push must have occurred within the last 6 hours. -- There is no open PR for this branch. +- There is no open pull request for this branch. ## Reviews @@ -125,7 +125,7 @@ That's it. You can now push your changes and create the pull request as usual by Please keep in mind that project owners can do _everything_, including editing and rewriting the history using `force-push`. In some cases, this is a useful feature (for example, to undo accidental commits or clean up PRs), -but in most cases, a transparent history based on a pull request-based workflow is surely preferable, +but in most cases, a transparent history based on a pull-request-based workflow is surely preferable, especially for the default branches of your project where other people rely on intact history. **Warning** If you accidentally leaked sensitive data, say, leaked credentials,