From e0547c5497a662d82deb298679c5abb3becb31c7 Mon Sep 17 00:00:00 2001 From: Aivaras Date: Sat, 12 Apr 2025 19:49:47 +0300 Subject: [PATCH] Fix minor issues in most packages pages --- docs/user/packages/alpine.md | 2 +- docs/user/packages/alt.md | 4 ++-- docs/user/packages/arch.md | 2 +- docs/user/packages/cargo.md | 8 ++++---- docs/user/packages/chef.md | 6 +++--- docs/user/packages/composer.md | 2 +- docs/user/packages/cran.md | 2 +- docs/user/packages/debian.md | 2 +- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/user/packages/alpine.md b/docs/user/packages/alpine.md index f8f2d5e2..ed21a97b 100644 --- a/docs/user/packages/alpine.md +++ b/docs/user/packages/alpine.md @@ -32,7 +32,7 @@ If the registry is private, provide credentials in the url. You can use a passwo https://{username}:{your_password_or_token}@forgejo.example.com/api/packages/{owner}/alpine// ``` -The Alpine registry files are signed with a RSA key which must be known to apk. Download the public key and store it in `/etc/apk/keys/`: +The Alpine registry files are signed with a RSA key which must be known to `apk`. Download the public key and store it in `/etc/apk/keys/`: ```shell curl -JO https://forgejo.example.com/api/packages/{owner}/alpine/key diff --git a/docs/user/packages/alt.md b/docs/user/packages/alt.md index 003ef6fb..18f170d4 100644 --- a/docs/user/packages/alt.md +++ b/docs/user/packages/alt.md @@ -36,13 +36,13 @@ rpm https://forgejo.example.com/api/packages/testuser/alt/alt.repo x86_64 classi rpm https://forgejo.example.com/api/packages/testuser/alt/group/example1.repo noarch classic ``` -If the registry is private, provide credentials in the url. You can use a password or a personal access token: +If the registry is private, provide credentials in the URL. You can use a password or a personal access token: ```shell rpm https://{username}:{your_password_or_token}@forgejo.example.com/api/packages/{owner}/alt/{group}.repo {arch} classic ``` -You have to add the credentials to the urls in the created `.repo` file in `/etc/apt/sources.list.d/` too. +You have to add the credentials to the URLs in the created `.repo` file in `/etc/apt/sources.list.d/` too. ## Publish a package diff --git a/docs/user/packages/arch.md b/docs/user/packages/arch.md index 801a60b8..04615787 100644 --- a/docs/user/packages/arch.md +++ b/docs/user/packages/arch.md @@ -42,7 +42,7 @@ You can also copy content from the Forgejo package page. | `group` | [Repository](https://wiki.archlinux.org/title/Official_repositories), e.g. `os`, `extras` | | `architecture` | System architecture, such as `x86_64`, `aarch64` | -Then, Import the server's public key. +Then, import the server's public key. ```bash # Download the public key from the remote server. diff --git a/docs/user/packages/cargo.md b/docs/user/packages/cargo.md index 2f9bce9f..a47f0e79 100644 --- a/docs/user/packages/cargo.md +++ b/docs/user/packages/cargo.md @@ -17,13 +17,13 @@ The following section describes how to create it. ## Index Repository Cargo stores information about the available packages in a package index stored in a git repository. -In Forgejo this repository has the special name `_cargo-index`. +In Forgejo, this repository has the special name `_cargo-index`. After a package was uploaded, its metadata is automatically written to the index. The content of this repository should not be manually modified. The user or organization package settings page allows to create the index repository along with the configuration file. -If needed this action will rewrite the configuration file. -This can be useful if for example the Forgejo instance domain was changed. +If needed, this action will rewrite the configuration file. +This can be useful if, for example, the Forgejo instance domain was changed. If the case arises where the packages stored in Forgejo and the information in the index repository are out of sync, the settings page allows to rebuild the index repository. This action iterates all packages in the registry and writes their information to the index. @@ -32,7 +32,7 @@ If there are lot of packages this process may take some time. ## Configuring the package registry To register the package registry the Cargo configuration must be updated. -Add the following text to the configuration file located in the current users home directory (for example `~/.cargo/config.toml`): +Add the following text to the configuration file located in the current users home directory (for example: `~/.cargo/config.toml`): ``` [registry] diff --git a/docs/user/packages/chef.md b/docs/user/packages/chef.md index 578f50d4..e98dfbe4 100644 --- a/docs/user/packages/chef.md +++ b/docs/user/packages/chef.md @@ -19,7 +19,7 @@ Only the public key is stored inside Forgejo. If you lose access to the private ## Configure the package registry -To [configure `knife`](https://docs.chef.io/workstation/knife_setup/) to use the Forgejo package registry add the url to the `~/.chef/config.rb` file. +To [configure `knife`](https://docs.chef.io/workstation/knife_setup/) to use the Forgejo package registry, add this URL to the `~/.chef/config.rb` file: ``` knife[:supermarket_site] = 'https://forgejo.example.com/api/packages/{owner}/chef' @@ -51,7 +51,7 @@ To install a package from the package registry, execute the following command: knife supermarket install {package_name} ``` -Optional you can specify the package version: +Optionally, you can specify the package version: ```shell knife supermarket install {package_name} {package_version} @@ -70,7 +70,7 @@ If you want to remove a package from the registry, execute the following command knife supermarket unshare {package_name} ``` -Optional you can specify the package version: +Optionally, you can specify the package version: ```shell knife supermarket unshare {package_name}/versions/{package_version} diff --git a/docs/user/packages/composer.md b/docs/user/packages/composer.md index 7cb65e62..87f1e21d 100644 --- a/docs/user/packages/composer.md +++ b/docs/user/packages/composer.md @@ -59,7 +59,7 @@ The server responds with the following HTTP Status codes. ## Configuring the package registry -To register the package registry you need to add it to the Composer `config.json` file (which can usually be found under `/.composer/config.json`): +To register the package registry you need to add it to the Composer `config.json` file (which can usually be found under `~/.composer/config.json`): ```json { diff --git a/docs/user/packages/cran.md b/docs/user/packages/cran.md index fda32f48..1b10bcf8 100644 --- a/docs/user/packages/cran.md +++ b/docs/user/packages/cran.md @@ -58,7 +58,7 @@ curl --user your_username:your_password_or_token \ https://forgejo.example.com/api/packages/testuser/cran/bin?platform=windows&rversion=4.2 ``` -If you are using 2FA or OAuth use a personal access token instead of the password. +If you are using 2FA or OAuth, use a personal access token instead of the password. You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first. diff --git a/docs/user/packages/debian.md b/docs/user/packages/debian.md index 5f16067f..2ca0be04 100644 --- a/docs/user/packages/debian.md +++ b/docs/user/packages/debian.md @@ -26,7 +26,7 @@ echo "deb [signed-by=/etc/apt/keyrings/forgejo-{owner}.asc] https://forgejo.exam | `distribution` | The distribution to use. | | `component` | The component to use. | -If the registry is private, provide credentials in the url. You can use a password or a [personal access token](../../api-usage/#authentication): +If the registry is private, provide credentials in the URL. You can use a password or a [personal access token](../../api-usage/#authentication): ```shell echo "deb [signed-by=/etc/apt/keyrings/forgejo-{owner}.asc] https://{username}:{your_password_or_token}@forgejo.example.com/api/packages/{owner}/debian {distribution} {component}" | sudo tee -a /etc/apt/sources.list.d/forgejo.list