forked from docs/team-docs
Changed pagure links to forge and updated screenshots (#52)
Reviewed-on: docs/team-docs#52 Reviewed-by: Petr Bokoč <pbokoc@noreply.forge.fedoraproject.org> Co-authored-by: Kaktusstudia <jonas.hubeny@gmail.com> Co-committed-by: Kaktusstudia <jonas.hubeny@gmail.com>
This commit is contained in:
parent
781aace54b
commit
f3fd5bdccf
9 changed files with 11 additions and 19 deletions
Binary file not shown.
|
Before Width: | Height: | Size: 92 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 93 KiB After Width: | Height: | Size: 90 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 91 KiB After Width: | Height: | Size: 193 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 92 KiB |
|
|
@ -13,7 +13,7 @@ Sometimes you may want to use the same data across many AsciiDoc documents.
|
|||
Some examples are below:
|
||||
|
||||
* Version releases (e.g. Fedora `N`)
|
||||
* URL prefixes or suffixes (e.g. `https://pagure.io/fesco/issues/`)
|
||||
* URL prefixes or suffixes (e.g. `https://forge.fedoraproject.org/fesco`)
|
||||
* Dates and time (e.g. current year, like `2020`)
|
||||
|
||||
For these and more use cases, *attributes* allow you to define some metadata in a single place, and reuse it in multiple places.
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ image::contrib-quickdocs/report-issue.png[]
|
|||
|
||||
The subject field already contains a link to the affected document. Don't change it. Please, provide a description of the issue and if possible provide a concise suggested modification, preferably cut&paste ready.
|
||||
|
||||
If you are not logged to pagure, a FAS login window will open first.
|
||||
If you are not logged to forge, a FAS login window will open first.
|
||||
|
||||
IMPORTANT: Many of the repositories have now been migrated to https://forge.fedoraproject.org[Fedora Forge].
|
||||
|
||||
|
|
@ -73,15 +73,6 @@ image::contrib-quickdocs/report-issue.png[]
|
|||
|
||||
The next steps are explained in detail in the article xref:contributing-docs/tools-file-edit-pagure.adoc[How to edit files on the Pagure Web UI].
|
||||
|
||||
=== Self-assign issues
|
||||
|
||||
You can find and contribute to needed changes by following the https://pagure.io/fedora-docs/quick-docs/issues[Quick Docs Issue Board], where users share blunders in the documentation or suggestions for enhancing it.
|
||||
|
||||
If you find issue that matches your interest and expertise, on assignee on top right, press *take* link to assign issue to yourself.
|
||||
|
||||
.Assign issues
|
||||
image::contrib-quickdocs/assign-issues.png[]
|
||||
|
||||
== How to contribute
|
||||
|
||||
Quick Docs uses the same CMS as all other Fedora Docs, so the tools are the same. You find detailed guides in the section Contribution Tools.
|
||||
|
|
@ -108,7 +99,7 @@ Watch status in the middle of Quick Doc report has four options. Select one of t
|
|||
|
||||
- Unwatch
|
||||
|
||||
Notification will go to your email as in user settings of Pagure.
|
||||
Notification will go to your email as in user settings of Forge.
|
||||
|
||||
.Notification options
|
||||
image::contrib-quickdocs/watch-notification.png[]
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ Hanku Lee, Peter Boy; Fedora Documentation Team
|
|||
:revdate: 2023-03-19
|
||||
|
||||
[abstract]
|
||||
Fedora Pagure is an Open Source software code hosting system that supports various Fedora project repositories such as, but not limited to, Quick Docs, Server, EPEL (Extra Packages for Enterprise Linux), Modularity and Packaging Committee. This article steps through contribution process for Quick Docs, which contain how-to guides and tutorials for the Fedora Linux. The overall process can be translated for any other Pagure projects. Pre-requisites to begin your first contribution are Fedora account ID, signed contributor agreement, and some familiarity with git pull request. Docs team is looking for more folks from the community helping with docs.
|
||||
Fedora Forge is an Open Source software code hosting system that supports various Fedora project repositories such as, but not limited to, Quick Docs, Server, EPEL (Extra Packages for Enterprise Linux), Modularity and Packaging Committee. This article steps through contribution process for Quick Docs, which contain how-to guides and tutorials for the Fedora Linux. The overall process can be translated for any other Forge projects. Pre-requisites to begin your first contribution are Fedora account ID, signed contributor agreement, and some familiarity with git pull request. Docs team is looking for more folks from the community helping with docs.
|
||||
|
||||
== How to find tasks
|
||||
|
||||
|
|
@ -11,7 +11,7 @@ Whether it is broken link, outdated screenshots of graphical user interface, tec
|
|||
|
||||
The best place to find how to contribute to Quick Docs is issue board where users report documentation bugs or suggestions to improve documentation.
|
||||
|
||||
Track issues on the link: https://pagure.io/fedora-docs/quick-docs/issues
|
||||
Track issues on the link: https://forge.fedoraproject.org/docs/quick-docs/issues
|
||||
|
||||
=== Self-assign issues
|
||||
|
||||
|
|
@ -44,9 +44,9 @@ Pull Requests promote collaborative work flow between writers and reviewers wher
|
|||
Please find general Pull Requests (PR) work flow. See the link:
|
||||
xref:contributing-docs/tools-local-authoring-env.adoc#prerequisites[How to create and use a local authoring environment]
|
||||
|
||||
=== Create a pull request from Pagure User Interface
|
||||
=== Create a pull request from Forge User Interface
|
||||
|
||||
- Go to your forked project and click *View Fork* on top right of Quick Docs project landing page: https://pagure.io/fedora-docs/quick-docs
|
||||
- Go to your forked project and click *View Fork* on top right of Quick Docs project landing page: https://forge.fedoraproject.org/docs/quick-docs/
|
||||
|
||||
- On your fork, click Open PR and New Pull Request
|
||||
|
||||
|
|
@ -70,7 +70,7 @@ Watch status in the middle of Quick Doc report has four options. Select one of t
|
|||
|
||||
- Unwatch
|
||||
|
||||
Notification will go to your email as in user settings of Pagure.
|
||||
Notification will go to your email as in user settings of Forge.
|
||||
|
||||
.Notification options
|
||||
image::pagure-guide/watch-notification.png[]
|
||||
|
|
|
|||
|
|
@ -59,12 +59,12 @@ content:
|
|||
sources:
|
||||
- url: .
|
||||
branches: HEAD
|
||||
- url: https://pagure.io/fedora-docs/another-repository.git
|
||||
- url: https://forge.fedoraproject.org/docs/another-repository.git
|
||||
branches: main
|
||||
----
|
||||
|
||||
Correct entries to use can be found from
|
||||
https://pagure.io/fedora-docs/docs-fp-o/blob/prod/f/site.yml[docs-fp-o site.yml].
|
||||
https://forge.fedoraproject.org/docs/docs-fp-o/src/branch/prod/site.yml[docs-fp-o site.yml].
|
||||
|
||||
== Using the regular Antora scripts
|
||||
If you want to use the regular Antora build and preview workflow - follow the instructions on https://docs.antora.org/[Antora Documentation page].
|
||||
|
|
|
|||
1
preview.pid
Normal file
1
preview.pid
Normal file
|
|
@ -0,0 +1 @@
|
|||
10709
|
||||
Loading…
Add table
Add a link
Reference in a new issue