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

url replaced with xref for quick docs repo contribution page

Browse source
This commit is contained in:
hank L 2023-03-20 22:28:29 +00:00
commit 86902a9483
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
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-10
: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.
@ -32,7 +32,8 @@ Beyond style guide, here are a few rule sets contributors need to observe.
- 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/
- Run prose linter like vale locally before PR. Check this link:
xref:contributing-docs/tools-vale-linter.adoc#prerequisites[How to check documentation style with Vale]
== Pull Requests and review
@ -40,7 +41,8 @@ Pull Requests promote collaborative work flow between writers and reviewers wher
=== Write changes and push to Quick Docs 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/
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