egret/team-docs
1
0
Fork 1
forked from docs/team-docs
Code Pull requests Wiki Activity

Write changes and push to Quick Docs repo rearranged prior to PR

Browse source
This commit is contained in:
Test Lab 2023-03-09 23:21:40 +00:00 • committed by hankuoffroad
commit 2bff36eb54
1 changed files with 10 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

16
modules/ROOT/pages/contributing-docs/contributions-quick-repo.adoc
View file

@ -1,6 +1,6 @@
= How to contribute to Quick Docs repo
Hanku Lee, Peter Boy; Fedora Documentation Team
:revdate: 2023-03-09
:revdate: 2023-03-10
[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.
@ -15,7 +15,7 @@ Track issues on the link: https://pagure.io/fedora-docs/quick-docs/issues
=== Self-assign issues
If you find issue that matches your interest and expertise, on assignee field, press *take* link to assign to yourself.
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::pagure-guide/assign-issues.png[]
@ -26,7 +26,7 @@ Beyond style guide, here are a few rule sets contributors need to observe.
- The process Docs team treat bugs in documentation follows the same principle as code bugs where continuous integration, automated testing, and gradual improvements for documentation quality are adopted.
- All changes to Quick Docs must be done via Pull Requests from forked project. Quick Docs project does not support direct push to its upstream repo. Please find general Pull Requests (PR) work flow. See the link: https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/tools-local-authoring-env/
- All changes to Quick Docs must be done via Pull Requests from forked project. Quick Docs project does not support direct push to its upstream repo.
- If you fix contents about new features, releases or new content, test the application and process in a new system or freshly installed Virtual Machine with all updates applied.
@ -38,9 +38,13 @@ Beyond style guide, here are a few rule sets contributors need to observe.
Pull Requests promote collaborative work flow between writers and reviewers where PR comments, edits and commits serve as review process.
=== Create a pull request from Quick Docs project
=== Write changes and push to Quick Docs repo
- 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
Please find general Pull Requests (PR) work flow. See the link: https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/tools-local-authoring-env/
=== Create a pull request from Pagure 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
- On your fork, click Open PR and New Pull Request
@ -54,7 +58,7 @@ Pull Requests promote collaborative work flow between writers and reviewers wher
=== Notification after PR
Watch status in the middle has four options to choose from.
Watch status in the middle of Quick Doc report has four options. Select one of the options from below.
- Watch Issues and PRs