mirror of
https://codeberg.org/forgejo/docs.git
synced 2024-12-24 22:32:43 -05:00
replace 1.19 with 1.20 where relevant
This commit is contained in:
parent
d5f7cdda50
commit
1d88a5c1a7
11 changed files with 17 additions and 17 deletions
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
layout: '~/layouts/Markdown.astro'
|
layout: '~/layouts/Markdown.astro'
|
||||||
title: 'Forgejo v1.19 administrator guide'
|
title: 'Forgejo administrator guide'
|
||||||
---
|
---
|
||||||
|
|
||||||
These documents are targeted to people who run Forgejo on their machines.
|
These documents are targeted to people who run Forgejo on their machines.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
layout: '~/layouts/Markdown.astro'
|
layout: '~/layouts/Markdown.astro'
|
||||||
title: 'Forgejo v1.19 developer guide'
|
title: 'Forgejo developer guide'
|
||||||
---
|
---
|
||||||
|
|
||||||
This area will be targeted to people who want to hack Forgejo and adjust it to
|
This area will be targeted to people who want to hack Forgejo and adjust it to
|
||||||
|
|
2
index.md
2
index.md
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
layout: '~/layouts/Markdown.astro'
|
layout: '~/layouts/Markdown.astro'
|
||||||
title: 'Forgejo v1.19 documentation'
|
title: 'Forgejo v1.20 documentation'
|
||||||
---
|
---
|
||||||
|
|
||||||
* [What is Forgejo?](https://forgejo.org/)
|
* [What is Forgejo?](https://forgejo.org/)
|
||||||
|
|
|
@ -19,7 +19,7 @@ When you're logged in, you can use one of the two buttons shown in the two follo
|
||||||
|
|
||||||
This will lead you to this page below.
|
This will lead you to this page below.
|
||||||
|
|
||||||
![screenshot of new repository page](../../../../images/v1.19/user/first-repository/create-repo-2.png)
|
![screenshot of new repository page](../../../../images/v1.20/user/first-repository/create-repo-2.png)
|
||||||
|
|
||||||
Here's an explanation of the form's fields:
|
Here's an explanation of the form's fields:
|
||||||
|
|
||||||
|
@ -40,7 +40,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/v1.19/user/first-repository/create-repo-3.png)
|
![screenshot showing a freshly baken repository](../../../../images/v1.20/user/first-repository/create-repo-3.png)
|
||||||
|
|
||||||
Here's what the most important buttons do:
|
Here's what the most important buttons do:
|
||||||
|
|
||||||
|
@ -89,7 +89,7 @@ knut@iceberg:~/repositories$
|
||||||
|
|
||||||
To clone your newly created repository, execute `git clone` with the URL that is shown in your repository:
|
To clone your newly created repository, execute `git clone` with the URL that is shown in your repository:
|
||||||
|
|
||||||
![screenshot of the two options to receive a clone URL for git](../../../../images/v1.19/user/first-repository/repo-url.png)
|
![screenshot of the two options to receive a clone URL for git](../../../../images/v1.20/user/first-repository/repo-url.png)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
knut@iceberg:~/repositories$ git clone https://codeberg.org/knut/foobar
|
knut@iceberg:~/repositories$ git clone https://codeberg.org/knut/foobar
|
||||||
|
@ -254,6 +254,6 @@ When connecting via HTTPS, Git will ask you for your username and password, whic
|
||||||
|
|
||||||
After refreshing the repository page, you should now see something similar to this:
|
After refreshing the repository page, you should now see something similar to this:
|
||||||
|
|
||||||
![screenshot showing the updated README on Codeberg](../../../../images/v1.19/user/first-repository/hello-world.png)
|
![screenshot showing the updated README on Codeberg](../../../../images/v1.20/user/first-repository/hello-world.png)
|
||||||
|
|
||||||
Congratulations - you've just made your first source code contribution on Forgejo!
|
Congratulations - you've just made your first source code contribution on Forgejo!
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
layout: '~/layouts/Markdown.astro'
|
layout: '~/layouts/Markdown.astro'
|
||||||
title: 'Forgejo v1.19 user guide'
|
title: 'Forgejo user guide'
|
||||||
---
|
---
|
||||||
|
|
||||||
These documents are targeted to people who are using Forgejo but are not
|
These documents are targeted to people who are using Forgejo but are not
|
||||||
|
|
|
@ -12,7 +12,7 @@ direction, ask questions and much more.
|
||||||
|
|
||||||
### The Issue Tracker
|
### The Issue Tracker
|
||||||
|
|
||||||
![Issues list](../../../../images/v1.19/user/issue-tracking-basics/issues-list.png)
|
![Issues list](../../../../images/v1.20/user/issue-tracking-basics/issues-list.png)
|
||||||
|
|
||||||
You can access the issue tracker of a project by clicking its "Issues" tab **(1)**.
|
You can access the issue tracker of a project by clicking its "Issues" tab **(1)**.
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ You can use labels to classify issues and pull requests and to improve your over
|
||||||
|
|
||||||
For repositories, labels can be created by going to `Issues` and clicking on `Labels`.
|
For repositories, labels can be created by going to `Issues` and clicking on `Labels`.
|
||||||
|
|
||||||
![create a label](../../../../images/v1.19/user/labels/label-new.png)
|
![create a label](../../../../images/v1.20/user/labels/label-new.png)
|
||||||
|
|
||||||
For organizations, you can define organization-wide labels that are shared with all organization repositories, including both already-existing repositories as well as newly created ones. Organization-wide labels can be created in the organization `Settings`.
|
For organizations, you can define organization-wide labels that are shared with all organization repositories, including both already-existing repositories as well as newly created ones. Organization-wide labels can be created in the organization `Settings`.
|
||||||
|
|
||||||
|
@ -19,7 +19,7 @@ Labels have a mandatory name, a mandatory color, an optional description, and mu
|
||||||
|
|
||||||
When you create a repository, 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. Its contained labels will all be created as well while creating the repository.
|
When you create a repository, 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. Its contained labels will all be created as well while creating the repository.
|
||||||
|
|
||||||
![list of labels](../../../../images/v1.19/user/labels/label-apply.png)
|
![list of labels](../../../../images/v1.20/user/labels/label-apply.png)
|
||||||
|
|
||||||
When you create a repository, 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. Its contained labels will all be created as well while creating the repository.
|
When you create a repository, 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. Its contained labels will all be created as well while creating the repository.
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@ When you create a repository, you can ensure certain labels exist by using the `
|
||||||
|
|
||||||
Scoped labels are used to ensure at most a single label with the same scope is assigned to an issue or pull request. For example, if labels `kind/bug` and `kind/enhancement` have the Exclusive option set, an issue can only be classified as a bug or an enhancement.
|
Scoped labels are used to ensure at most a single label with the same scope is assigned to an issue or pull request. For example, if labels `kind/bug` and `kind/enhancement` have the Exclusive option set, an issue can only be classified as a bug or an enhancement.
|
||||||
|
|
||||||
![list of labels](../../../../images/v1.19/user/labels/label-list.png)
|
![list of labels](../../../../images/v1.20/user/labels/label-list.png)
|
||||||
|
|
||||||
A scoped label must contain `/` in its name (not at either end of the name). The scope of a label is determined based on the **last** `/`, so for example the scope of label `scope/subscope/item` is `scope/subscope`.
|
A scoped label must contain `/` in its name (not at either end of the name). The scope of a label is determined based on the **last** `/`, so for example the scope of label `scope/subscope/item` is `scope/subscope`.
|
||||||
|
|
||||||
|
|
|
@ -6,10 +6,10 @@ license: 'CC-BY-SA-4.0'
|
||||||
|
|
||||||
A project is a [kanban board](https://en.wikipedia.org/wiki/Kanban_(development)) to organize issues.
|
A project is a [kanban board](https://en.wikipedia.org/wiki/Kanban_(development)) to organize issues.
|
||||||
|
|
||||||
![screenshot of the project page](../../../../images/v1.19/user/project/project.png)
|
![screenshot of the project page](../../../../images/v1.20/user/project/project.png)
|
||||||
|
|
||||||
# Card previews images
|
# Card previews images
|
||||||
|
|
||||||
If the card preview in the project is set to **Images and Text**, the card preview displays images found in the corresponding issue. The most recent is displayed first, up to five images.
|
If the card preview in the project is set to **Images and Text**, the card preview displays images found in the corresponding issue. The most recent is displayed first, up to five images.
|
||||||
|
|
||||||
![example of card image preview](../../../../images/v1.19/user/project/project-image.png)
|
![example of card image preview](../../../../images/v1.20/user/project/project-image.png)
|
||||||
|
|
|
@ -14,7 +14,7 @@ request.
|
||||||
To protect a branch, you need to go to the repository’s **Settings** >
|
To protect a branch, you need to go to the repository’s **Settings** >
|
||||||
**Branch** page and add a new rule.
|
**Branch** page and add a new rule.
|
||||||
|
|
||||||
![Add a new rule](../../../../images/v1.19/user/protection/branch-protect.png)
|
![Add a new rule](../../../../images/v1.20/user/protection/branch-protect.png)
|
||||||
|
|
||||||
The name of the branch can be a glob where / is the separator and **
|
The name of the branch can be a glob where / is the separator and **
|
||||||
spans accross separators. For instance `main`, `release/**` or `precious*`.
|
spans accross separators. For instance `main`, `release/**` or `precious*`.
|
||||||
|
|
|
@ -184,6 +184,6 @@ There is a Test Delivery button in the webhook settings that allows to test the
|
||||||
|
|
||||||
Forgejo webhooks can be configured to send an [authorization header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) to the target.
|
Forgejo webhooks can be configured to send an [authorization header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) to the target.
|
||||||
|
|
||||||
![screenshot of the webhook definition webpage](../../../../images/v1.19/user/webhooks/authorization-header.png)
|
![screenshot of the webhook definition webpage](../../../../images/v1.20/user/webhooks/authorization-header.png)
|
||||||
|
|
||||||
The authentication string is stored encrypted in the database.
|
The authentication string is stored encrypted in the database.
|
||||||
|
|
|
@ -30,7 +30,7 @@ After you have enabled the wiki you are prompted to create the initial page `Hom
|
||||||
|
|
||||||
The web UI in your browser is currently limited to adding, updating, and deleting pages; you can't manage assets like images this way.
|
The web UI in your browser is currently limited to adding, updating, and deleting pages; you can't manage assets like images this way.
|
||||||
|
|
||||||
![Wiki home page with edit buttons](../../../../images/v1.19/user/wiki/wiki_pageview.png)
|
![Wiki home page with edit buttons](../../../../images/v1.20/user/wiki/wiki_pageview.png)
|
||||||
|
|
||||||
## Adding content via a local Git client
|
## Adding content via a local Git client
|
||||||
You can work with the wiki repo as you would with any other Git repo on Forgejo.
|
You can work with the wiki repo as you would with any other Git repo on Forgejo.
|
||||||
|
|
Loading…
Reference in a new issue