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

Add hyphen to multiword tag

Browse source 
Signed-off-by: David Kirwan <dkirwan@redhat.com>
This commit is contained in:
David Kirwan 2023-08-04 10:01:18 +01:00
commit 01d57be3e7
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
modules/ROOT/pages/contributing-docs/contrib-quickdocs.adoc
View file

@ -31,7 +31,7 @@ If your post does not fit into either category, consider an article under Admini
== Who can contribute
**Everyone** can contribute and everyone is welcome! There are some minor and easy to meet requirements, though. The most important is a Fedora account having signed the https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[Fedora Project Contributor Agreement]. This is essential to protect Fedora from any potential licensing issues. Of course, some knowledge of the AsciiDOC markup language is helpful, but you can get along very well without it. This is especially true when correcting and revising existing articles. One can easily get into the existing flow.
**Everyone** can contribute and everyone is welcome! There are some minor and easy to meet requirements, though. The most important is a Fedora account having signed the https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[Fedora Project Contributor Agreement]. This is essential to protect Fedora from any potential licensing issues. Of course, some knowledge of the AsciiDOC markup language is helpful, but you can get along very well without it. This is especially true when correcting and revising existing articles. One can easily get into the existing flow.
An important fact is, _no special knowledge_ is required! You don't need to know anything about desktop publishing, complicated formatting tricks or anything like that.
@ -64,12 +64,12 @@ The subject field already contains a link to the affected document. Don't change
If you are not logged to pagure, a FAS login window will open first.
The second link opens a web editor, you can use to enter proposed modifications directly in the text.
The second link opens a web editor, you can use to enter proposed modifications directly in the text.
.The web editor
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].
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
@ -79,18 +79,18 @@ If you find issue that matches your interest and expertise, on assignee on top r
.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.
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.
=== Pull Requests and review
In either case, the workflow follows the "pull request" or "merge request" model. Changes are not made in the existing, published text but in a side version. When the work is complete, a "merge request" is triggered. Members of the community will look at the changes and either start a discussion or accept the changes. They will then be merged into the published version. We thus follow the 4-eyes principle.
In either case, the workflow follows the "pull request" or "merge request" model. Changes are not made in the existing, published text but in a side version. When the work is complete, a "merge request" is triggered. Members of the community will look at the changes and either start a discussion or accept the changes. They will then be merged into the published version. We thus follow the 4-eyes principle.
Pull Requests promote collaborative work flow between writers and reviewers where PR comments, edits and commits serve as review process.
The individual steps are largely automatic. Details are described in the respective tools.
The individual steps are largely automatic. Details are described in the respective tools.
=== Notification after PR
@ -160,7 +160,7 @@ AUTHOR_1; AUTHOR_2; AUTHOR_3
[abstract]
------
Mission statement of 2-3 sentences
Mission statement of 2-3 sentences
------
----
@ -218,7 +218,7 @@ You can select __multipe tags__!
* 3rd level tags, optional, choose multiple
** Problem solving / Troubleshooting
** Problem-solving / Troubleshooting
** Printing / Scanning
** SELinux
@ -226,4 +226,4 @@ You are free to choose additional 3rd level tag(s) if none fits your contributio
== 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!
Help us with the issues, PRs, onboarding new contributors or keeping our stock of articles as a whole up to date. Thank you!