contributing to Quick Docs repo - new page

This commit is contained in:
hank L 2023-03-08 21:06:57 +00:00
commit 759c723a9c
4 changed files with 82 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

View file

@ -20,8 +20,7 @@
** Contribution Tools
*** xref:contributing-docs/tools-gitlab-howto.adoc[HowTo for casual contributions (for GitLab-based pages)]
// ** xref:contributing-docs/7step-pagure-howto.adoc[7 Step HowTo for casual contributions (for Pagure-based pages)]
*** HowTo for casual contributions (for Pagure-based pages)
*** xref:contributing-docs/contributions-quick-repo.adoc[How to contribute to Quick Docs repo]
//** xref:contributing-docs/use-web-ide-ui.adoc[How to profoundly use the Gitlab web IDE (permanent members)]
*** How to profoundly use the Gitlab web IDE (permanent members)
//** xref:contributing-docs/use-file-edit-if.adoc[How to profoundly use Pagure (permanent members)]

View file

@ -0,0 +1,81 @@
= How to contribute to Quick Docs repo
Hanku Lee, Peter Boy; Fedora Documentation Team
:revdate: 2023-03-08
[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.
== How to find tasks
Whether it is broken link, outdated screenshots of graphical user interface, technical and grammatical error in Quick Docs, every little contribution helps Fedora Linux users.
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
=== Self-assign issues
If you find issue that matches your interest and expertise, please leave a comment, asking if someone is working on it and, if not, you want to assign it to yourself.
- Click edit (pen) button
- On assignee field, type your Fedora User name and click it
- Label tags: select tags like improvement, needs changes, where relevant
- Click *Update* button down below
.Assign issues
image::pagure-guide/assign-issues.png[]
== Rule sets
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/
- 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.
- Do not use screenshot of terminal. Provide source code block of a particular language or shell commands.
- Run prose linter like vale locally before PR. Check this link: https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/tools-vale-linter/
== Pull Requests and review
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
- 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
- Locate your feature branch (pull from) next to your fork, under main branch
- Fill in Pull Request Title and describe your changes
- Check files changed and commits before Pull Request
- Press the Create Pull Request button below on the right
=== Notification after PR
Watch status in the middle has four options to choose from.
- Watch Issues and PRs
- Watch Commits
- Watch Issues, PRs, and Commits
- Unwatch
Notification will go to your email as in user settings of Pagure.
.Notification options
image::pagure-guide/watch-notification.png[]
If you do not hear from reviewers after your PR longer than a week, leave a comment in PR to follow up.
== Docs team needs your help
Help us with the issues, PRs, onboarding new contributors or keeping our stock of articles as a whole up to date. Thank you!