mirror of
https://codeberg.org/forgejo/docs.git
synced 2024-11-21 17:36:59 -05:00
fix: broken links from Gitea docs import
Invalid link templates left over from docs import from Gitea. Closes https://codeberg.org/forgejo/website/issues/160
This commit is contained in:
Caesar Schinas
parent
ba892adf7f
commit
c6ab3c37fb
18 changed files with 68 additions and 68 deletions
|
|
@ -81,7 +81,7 @@ Sometimes a commit or pull request may fix or bring back a problem documented
|
|||
in a particular issue. Forgejo supports closing and reopening the referenced
|
||||
issues by preceding the reference with a particular _keyword_. Common keywords
|
||||
include "closes", "fixes", "reopens", etc. This list can be
|
||||
[customized]({{< ref "/doc/advanced/config-cheat-sheet.en-us.md" >}}) by the
|
||||
[customized](../../admin/config-cheat-sheet/) by the
|
||||
site administrator.
|
||||
|
||||
Example:
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ https://forgejo.example.com/api/packages/{owner}/alpine/<branch>/<repository>
|
|||
| `branch` | The branch to use. |
|
||||
| `repository` | The repository to use. |
|
||||
|
||||
If the registry is private, provide credentials in the url. You can use a password or a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}):
|
||||
If the registry is private, provide credentials in the url. You can use a password or a [personal access token](../../api-usage/#authentication):
|
||||
|
||||
```
|
||||
https://{username}:{your_password_or_token}@forgejo.example.com/api/packages/{owner}/alpine/<branch>/<repository>
|
||||
|
|
@ -66,7 +66,7 @@ curl --user your_username:your_password_or_token \
|
|||
https://forgejo.example.com/api/packages/testuser/alpine/v3.17/main
|
||||
```
|
||||
|
||||
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password.
|
||||
If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password.
|
||||
You cannot publish a file with the same name twice to a package. You must delete the existing package file first.
|
||||
|
||||
The server responds with the following HTTP Status codes.
|
||||
|
|
|
|||
|
|
@ -57,9 +57,9 @@ Add the credentials section to the credentials file located in the current users
|
|||
token = "Bearer {token}"
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| --------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `token` | Your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) |
|
||||
| Parameter | Description |
|
||||
| --------- | ------------------------------------------------------------- |
|
||||
| `token` | Your [personal access token](../../api-usage/#authentication) |
|
||||
|
||||
## Publish a package
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ curl --user your_username:your_password_or_token \
|
|||
https://forgejo.example.com/api/packages/testuser/composer?version=1.0.3
|
||||
```
|
||||
|
||||
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password.
|
||||
If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password.
|
||||
|
||||
The server responds with the following HTTP Status codes.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,12 +19,12 @@ conan remote add {remote} https://forgejo.example.com/api/packages/{owner}/conan
|
|||
conan user --remote {remote} --password {password} {username}
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `remote` | The remote name. |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. |
|
||||
| `owner` | The owner of the package. |
|
||||
| Parameter | Description |
|
||||
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `remote` | The remote name. |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password. |
|
||||
| `owner` | The owner of the package. |
|
||||
|
||||
For example:
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ To push an image or if the image is in a private registry, you have to authentic
|
|||
docker login forgejo.example.com
|
||||
```
|
||||
|
||||
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password.
|
||||
If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password.
|
||||
|
||||
## Image naming convention
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ echo "deb https://forgejo.example.com/api/packages/{owner}/debian {distribution}
|
|||
| `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]({{< relref "doc/development/api-usage.en-us.md#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 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
|
||||
|
|
@ -66,7 +66,7 @@ curl --user your_username:your_password_or_token \
|
|||
https://forgejo.example.com/api/packages/testuser/debian/pool/bionic/main/upload
|
||||
```
|
||||
|
||||
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password.
|
||||
If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password.
|
||||
You cannot publish a file with the same name twice to a package. You must delete the existing package version first.
|
||||
|
||||
The server responds with the following HTTP Status codes.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Publish generic files, like release binaries or other output, for your user or o
|
|||
|
||||
## Authenticate to the package registry
|
||||
|
||||
To authenticate to the Package Registry, you need to provide [custom HTTP headers or use HTTP Basic authentication]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}).
|
||||
To authenticate to the Package Registry, you need to provide [custom HTTP headers or use HTTP Basic authentication](../../api-usage/#authentication).
|
||||
|
||||
## Publish a package
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ curl --user your_username:your_password_or_token \
|
|||
https://forgejo.example.com/api/packages/testuser/generic/test_package/1.0.0/file.bin
|
||||
```
|
||||
|
||||
If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password.
|
||||
If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password.
|
||||
|
||||
The server responds with the following HTTP Status codes.
|
||||
|
||||
|
|
|
|||
|
|
@ -25,13 +25,13 @@ helm repo add --username {username} --password {password} {repo} https://forgej
|
|||
helm cm-push ./{chart_file}.tgz {repo}
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. |
|
||||
| `repo` | The name for the repository. |
|
||||
| `chart_file` | The Helm Chart archive. |
|
||||
| `owner` | The owner of the package. |
|
||||
| Parameter | Description |
|
||||
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password. |
|
||||
| `repo` | The name for the repository. |
|
||||
| `chart_file` | The Helm Chart archive. |
|
||||
| `owner` | The owner of the package. |
|
||||
|
||||
## Install a package
|
||||
|
||||
|
|
|
|||
|
|
@ -54,10 +54,10 @@ Afterwards add the following sections to your project `pom.xml` file:
|
|||
</distributionManagement>
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| -------------- | ------------------------------------------------------------------------------------------------ |
|
||||
| `access_token` | Your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). |
|
||||
| `owner` | The owner of the package. |
|
||||
| Parameter | Description |
|
||||
| -------------- | -------------------------------------------------------------- |
|
||||
| `access_token` | Your [personal access token](../../api-usage/#authentication). |
|
||||
| `owner` | The owner of the package. |
|
||||
|
||||
### Gradle variant
|
||||
|
||||
|
|
|
|||
|
|
@ -23,11 +23,11 @@ npm config set {scope}:registry https://forgejo.example.com/api/packages/{owner}
|
|||
npm config set -- '//forgejo.example.com/api/packages/{owner}/npm/:_authToken' "{token}"
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| --------- | ------------------------------------------------------------------------------------------------ |
|
||||
| `scope` | The scope of the packages. |
|
||||
| `owner` | The owner of the package. |
|
||||
| `token` | Your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). |
|
||||
| Parameter | Description |
|
||||
| --------- | -------------------------------------------------------------- |
|
||||
| `scope` | The scope of the packages. |
|
||||
| `owner` | The owner of the package. |
|
||||
| `token` | Your [personal access token](../../api-usage/#authentication). |
|
||||
|
||||
For example:
|
||||
|
||||
|
|
|
|||
|
|
@ -20,12 +20,12 @@ To register the package registry you need to configure a new NuGet feed source:
|
|||
dotnet nuget add source --name {source_name} --username {username} --password {password} https://forgejo.example.com/api/packages/{owner}/nuget/index.json
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `source_name` | The desired source name. |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. |
|
||||
| `owner` | The owner of the package. |
|
||||
| Parameter | Description |
|
||||
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `source_name` | The desired source name. |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password. |
|
||||
| `owner` | The owner of the package. |
|
||||
|
||||
For example:
|
||||
|
||||
|
|
@ -33,7 +33,7 @@ For example:
|
|||
dotnet nuget add source --name forgejo --username testuser --password password123 https://forgejo.example.com/api/packages/testuser/nuget/index.json
|
||||
```
|
||||
|
||||
You can add the source without credentials and use the [`--api-key`](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-nuget-push) parameter when publishing packages. In this case you need to provide a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}).
|
||||
You can add the source without credentials and use the [`--api-key`](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-nuget-push) parameter when publishing packages. In this case you need to provide a [personal access token](../../api-usage/#authentication).
|
||||
|
||||
## Publish a package
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ dart pub token add https://forgejo.example.com/api/packages/{owner}/pub
|
|||
| ----------- | ------------------------- |
|
||||
| `owner` | The owner of the package. |
|
||||
|
||||
You need to provide your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}).
|
||||
You need to provide your [personal access token](../../api-usage/#authentication).
|
||||
|
||||
## Publish a package
|
||||
|
||||
|
|
|
|||
|
|
@ -24,11 +24,11 @@ username = {username}
|
|||
password = {password}
|
||||
```
|
||||
|
||||
| Placeholder | Description |
|
||||
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `owner` | The owner of the package. |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) instead of the password. |
|
||||
| Placeholder | Description |
|
||||
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `owner` | The owner of the package. |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password. |
|
||||
|
||||
## Publish a package
|
||||
|
||||
|
|
|
|||
|
|
@ -19,10 +19,10 @@ To register the package registry edit the `~/.gem/credentials` file and add:
|
|||
https://forgejo.example.com/api/packages/{owner}/rubygems: Bearer {token}
|
||||
```
|
||||
|
||||
| Parameter | Description |
|
||||
| --------- | ------------------------------------------------------------------------------------------------ |
|
||||
| `owner` | The owner of the package. |
|
||||
| `token` | Your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}). |
|
||||
| Parameter | Description |
|
||||
| --------- | -------------------------------------------------------------- |
|
||||
| `owner` | The owner of the package. |
|
||||
| `token` | Your [personal access token](../../api-usage/#authentication). |
|
||||
|
||||
For example:
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Whenever a package gets deleted only the references to the underlaying blobs are
|
|||
The blobs get not removed at this moment, so they still require space on the filesystem.
|
||||
When a new package gets uploaded the existing blobs may get referenced again.
|
||||
|
||||
These unreferenced blobs get deleted by a [clean up job]({{< relref "doc/advanced/config-cheat-sheet.en-us.md#cron---cleanup-expired-packages-croncleanup_packages" >}}).
|
||||
These unreferenced blobs get deleted by a [clean up job](../../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages).
|
||||
The config setting `OLDER_THAN` configures how long unreferenced blobs are kept before they get deleted.
|
||||
|
||||
## Cleanup Rules
|
||||
|
|
@ -57,7 +57,7 @@ The patterns are case-insensitive which matches the behaviour of the package reg
|
|||
|
||||
### How the cleanup rules work
|
||||
|
||||
The cleanup rules are part of the [clean up job]({{< relref "doc/advanced/config-cheat-sheet.en-us.md#cron---cleanup-expired-packages-croncleanup_packages" >}}) and run periodically.
|
||||
The cleanup rules are part of the [clean up job](../../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages) and run periodically.
|
||||
|
||||
The cleanup rule:
|
||||
|
||||
|
|
|
|||
|
|
@ -20,11 +20,11 @@ To register the package registry and provide credentials, execute:
|
|||
swift package-registry set https://forgejo.example.com/api/packages/{owner}/swift -login {username} -password {password}
|
||||
```
|
||||
|
||||
| Placeholder | Description |
|
||||
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `owner` | The owner of the package. |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. |
|
||||
| Placeholder | Description |
|
||||
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `owner` | The owner of the package. |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password. |
|
||||
|
||||
The login is optional and only needed if the package registry is private.
|
||||
|
||||
|
|
@ -46,15 +46,15 @@ curl -X PUT --user {username}:{password} \
|
|||
https://forgejo.example.com/api/packages/{owner}/swift/{scope}/{name}/{version}
|
||||
```
|
||||
|
||||
| Placeholder | Description |
|
||||
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token]({{< relref "doc/development/api-usage.en-us.md#authentication" >}}) instead of the password. |
|
||||
| `owner` | The owner of the package. |
|
||||
| `scope` | The package scope. |
|
||||
| `name` | The package name. |
|
||||
| `version` | The package version. |
|
||||
| `metadata` | (Optional) The metadata of the package. JSON encoded subset of https://schema.org/SoftwareSourceCode |
|
||||
| Placeholder | Description |
|
||||
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `username` | Your Forgejo username. |
|
||||
| `password` | Your Forgejo password. If you are using 2FA or OAuth use a [personal access token](../../api-usage/#authentication) instead of the password. |
|
||||
| `owner` | The owner of the package. |
|
||||
| `scope` | The package scope. |
|
||||
| `name` | The package name. |
|
||||
| `version` | The package version. |
|
||||
| `metadata` | (Optional) The metadata of the package. JSON encoded subset of https://schema.org/SoftwareSourceCode |
|
||||
|
||||
You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.
|
||||
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ vagrant box add "https://forgejo.example.com/api/packages/testuser/vagrant/test_
|
|||
```
|
||||
|
||||
This will install the latest version of the package. To add a specific version, use the `--box-version` parameter.
|
||||
If the registry is private you can pass your [personal access token]({{< relref "doc/developers/api-usage.en-us.md#authentication" >}}) in the `VAGRANT_CLOUD_TOKEN` environment variable.
|
||||
If the registry is private you can pass your [personal access token](../../api-usage/#authentication) in the `VAGRANT_CLOUD_TOKEN` environment variable.
|
||||
|
||||
## Supported commands
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue