foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-23 17:59:25 -05:00
Code Issues Activity

style: fix typos and use american spelling convention in some areas (#647)

Browse source 
You'll notice that asides from some typo fixes, "organisation" has been changed to "organization" to ensure a more consistent style guide, adapted to Codeberg's style: https://docs.codeberg.org/improving-documentation/style-guide/

Also changed "orgs" to "organizations" as it's more professional and easier to understand.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/647
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Abdur-Rahman Mansoor <armansoor@missingno.dev>
Co-committed-by: Abdur-Rahman Mansoor <armansoor@missingno.dev>
This commit is contained in:
Abdur-Rahman Mansoor 2024-05-25 14:28:28 +00:00 committed by Earl Warren
parent dc67b3c83a
commit 5c52eddd34
6 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/user/actions.md
View file

@ -176,7 +176,7 @@ triggered by parent commits are canceled.
## Services ## Services
PostgreSQL, redis and other services can be run from container images with something similar to the following. See also the [set of examples](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-service/.forgejo/workflows/). PostgreSQL, Redis and other services can be run from container images with something similar to the following. See also the [set of examples](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-service/.forgejo/workflows/).
```yaml ```yaml
services: services:

2
docs/user/code-search.md
View file

@ -15,6 +15,6 @@ Since, the searches are performed in the fly they may be performed on any valid
# Indexer # Indexer
For advanced search queries and searching across an entire organisation or instance, `REPO_INDEXER_ENABLED: true` enables code search via bleve/elasticsearch. For advanced search queries and searching across an entire organization or instance, `REPO_INDEXER_ENABLED: true` enables code search via bleve/elasticsearch.
However, search results are limited to the HEAD of the repository. However, search results are limited to the HEAD of the repository.

2
docs/user/email-settings.md
View file

@ -27,7 +27,7 @@ In the section “Manage Email Addresses”, you can select one of the following
When you're finished, press the button “Set Email Preference” to confirm your selection. When you're finished, press the button “Set Email Preference” to confirm your selection.
> **Note:** > **Note:**
> Disabling email notifications doesn't mean that you'll stop receiving important messages from the Forgejo organisation. > Disabling email notifications doesn't mean that you'll stop receiving important messages from the Forgejo organization.
## Issue notifications ## Issue notifications

6
docs/user/first-repository.md
View file

@ -28,7 +28,7 @@ Here's an explanation of the form's fields:
- **Description** A short description that appears next to your repository's name where appropriate - **Description** A short description that appears next to your repository's name where appropriate
- **Template** Occasionally you may want to generate your repository from an existing template. In that case, you can specify that template here. Otherwise, simply leave this field empty. - **Template** Occasionally you may want to generate your repository from an existing template. In that case, you can specify that template here. Otherwise, simply leave this field empty.
- **Issue Labels** If you want to initialize your project's issue tracker with a set of labels that you can use to categorize issues, you can choose one here. You don't have to choose this right away though, as you can choose and modify issue labels at a later time as well. - **Issue Labels** If you want to initialize your project's issue tracker with a set of labels that you can use to categorize issues, you can choose one here. You don't have to choose this right away though, as you can choose and modify issue labels at a later time as well.
- **.gitignore** A [.gitignore](https://git-scm.com/docs/gitignore) file defines which files Git should not keep track of. This is useful, for example to prevent configuration files or binaries to be tracked in version control. You can choose to add a pre-defined file matching the programming language you use now, or add one manually later. - **.gitignore** A [.gitignore](https://git-scm.com/docs/gitignore) file defines which files Git should not keep track of. This is useful, for example to prevent configuration files or binaries to be tracked in version control. You can choose to add a predefined file matching the programming language you use now, or add one manually later.
- **License** Here, you can choose from a list of FSF/OSI approved licenses. A `LICENSE` file will then be added to the repository. For some help on choosing the correct license, have a look at our [licensing article](/getting-started/licensing/). - **License** Here, you can choose from a list of FSF/OSI approved licenses. A `LICENSE` file will then be added to the repository. For some help on choosing the correct license, have a look at our [licensing article](/getting-started/licensing/).
- **README** is the first file one should read when accessing a repository. It's also the first file displayed when accessing a repository, a bit like the "homepage" of your repository. On Forgejo, this is interpreted as a [Markdown](/markdown/) file. - **README** is the first file one should read when accessing a repository. It's also the first file displayed when accessing a repository, a bit like the "homepage" of your repository. On Forgejo, this is interpreted as a [Markdown](/markdown/) file.
- **Initialize repository** In order to add the `LICENSE`, `README` and `.gitignore` files mentioned above to your new repository, make sure you tick this box. - **Initialize repository** In order to add the `LICENSE`, `README` and `.gitignore` files mentioned above to your new repository, make sure you tick this box.
@ -39,7 +39,7 @@ After filling out the fields, click the green "Create Repository" button on the
You should now see a screen similar to the one below. If you haven't chosen to generate `LICENSE`, `README` and `.gitignore` the screen might show instructions instead, which will vanish after [your first commit](#making-your-first-commit/). You should now see a screen similar to the one below. If you haven't chosen to generate `LICENSE`, `README` and `.gitignore` the screen might show instructions instead, which will vanish after [your first commit](#making-your-first-commit/).
![screenshot showing a freshly baken repository](../_images/user/first-repository/create-repo-3.png) ![screenshot showing a freshly baked repository](../_images/user/first-repository/create-repo-3.png)
Here's what the most important buttons do: Here's what the most important buttons do:
@ -135,7 +135,7 @@ When you clone a repository from the Internet, the URL that you got your copy of
If your local copy of the repository is missing some commits that exist in the remote repository, pushing will result in an error. There are two ways to fix this: If your local copy of the repository is missing some commits that exist in the remote repository, pushing will result in an error. There are two ways to fix this:
- Run `git pull` to combine your local changes with the changes that exist in the remote repository. If this does not work, please follow the instructions in your terminal. - Run `git pull` to combine your local changes with the changes that exist in the remote repository. If this does not work, please follow the instructions in your terminal.
- If you know what you are doing, you can also overwrite the remote repository uaing `git -f push`. - If you know what you are doing, you can also overwrite the remote repository using `git -f push`.
This action will **permanently** alter your remote repository and is not suitable if you are working on a project together with other people. This action will **permanently** alter your remote repository and is not suitable if you are working on a project together with other people.
## Making your first commit ## Making your first commit

2
docs/user/language-detection.md
View file

@ -32,7 +32,7 @@ While some of the categories are rather straightforward, a little explanation ab
**Dotfiles** are files whose name starts with a dot, which by convention, suggests they should be hidden, and as such, they are excluded from language statistics. **Dotfiles** are files whose name starts with a dot, which by convention, suggests they should be hidden, and as such, they are excluded from language statistics.
**Programming languages** and **Markup languages** are more or less self explanatory. The former category includes languages like C, Go, Rust, JavaScript, and many, many others. Markup languages are CSS, HTML, Jinja templates, Jupyter Notebooks, and numeruous other formats. **Programming languages** and **Markup languages** are more or less self explanatory. The former category includes languages like C, Go, Rust, JavaScript, and many, many others. Markup languages are CSS, HTML, Jinja templates, Jupyter Notebooks, and numerous other formats.
Please consult the [enry][enry] or [linguist][linguist] documentation for more details. Please consult the [enry][enry] or [linguist][linguist] documentation for more details.

6
docs/user/token-scope.md
View file

@ -30,7 +30,7 @@ Forgejo token scopes are as follows:
| &nbsp;&nbsp;&nbsp; **read:notification** | Grants read access to user notifications, such as which notifications users are subscribed to and read new notifications. | | &nbsp;&nbsp;&nbsp; **read:notification** | Grants read access to user notifications, such as which notifications users are subscribed to and read new notifications. |
| &nbsp;&nbsp;&nbsp; **write:notification** | Grants read/write/delete access to user notifications, such as marking notifications as read. | | &nbsp;&nbsp;&nbsp; **write:notification** | Grants read/write/delete access to user notifications, such as marking notifications as read. |
| **organization** | `orgs/*` and `teams/*` API routes: Organization and team management operations. | | **organization** | `orgs/*` and `teams/*` API routes: Organization and team management operations. |
| &nbsp;&nbsp;&nbsp; **read:organization** | Grants read access to org and team status, such as listing all orgs a user has visibility to, teams, and team members. | | &nbsp;&nbsp;&nbsp; **read:organization** | Grants read access to org and team status, such as listing all organizations a user has visibility to, teams, and team members. |
| &nbsp;&nbsp;&nbsp; **write:organization** | Grants read/write/delete access to org and team status, such as creating and updating teams and updating org settings. | | &nbsp;&nbsp;&nbsp; **write:organization** | Grants read/write/delete access to org and team status, such as creating and updating teams and updating org settings. |
| **package** | `/packages/*` API routes: Packages operations | | **package** | `/packages/*` API routes: Packages operations |
| &nbsp;&nbsp;&nbsp; **read:package** | Grants read access to package operations, such as reading and downloading available packages. | | &nbsp;&nbsp;&nbsp; **read:package** | Grants read access to package operations, such as reading and downloading available packages. |
@ -39,5 +39,5 @@ Forgejo token scopes are as follows:
| &nbsp;&nbsp;&nbsp; **read:repository** | Grants read access to repository operations, such as getting repository files, releases, collaborators. | | &nbsp;&nbsp;&nbsp; **read:repository** | Grants read access to repository operations, such as getting repository files, releases, collaborators. |
| &nbsp;&nbsp;&nbsp; **write:repository** | Grants read/write/delete access to repository operations, such as getting updating repository files, creating pull requests, updating collaborators. | | &nbsp;&nbsp;&nbsp; **write:repository** | Grants read/write/delete access to repository operations, such as getting updating repository files, creating pull requests, updating collaborators. |
| **user** | `/user/*` and `/users/*` API routes: User-related operations. | | **user** | `/user/*` and `/users/*` API routes: User-related operations. |
| &nbsp;&nbsp;&nbsp; **read:user** | Grants read access to user operations, such as getting user repo subscriptions and user settings. | | &nbsp;&nbsp;&nbsp; **read:user** | Grants read access to user operations, such as getting user repository subscriptions and user settings. |
| &nbsp;&nbsp;&nbsp; **write:user** | Grants read/write/delete access to user operations, such as updating user repo subscriptions, followed users, and user settings. | | &nbsp;&nbsp;&nbsp; **write:user** | Grants read/write/delete access to user operations, such as updating user repository subscriptions, followed users, and user settings. |