suzanne.soy/qubes-doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'stubbybubby-stubbybubby-doc-guidelines-edit'

Browse Source
This commit is contained in:
Andrew David Wong 2017-04-01 18:12:48 -07:00
commit 0b4d98d08e
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
2 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
basics_user/contributing.md
View File

@ -50,7 +50,7 @@ some common issue labels:
* [Debian](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+Debian%22) * [Debian](https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22C%3A+Debian%22)
Before you engage in an activity that will take you a significant amount of Before you engage in an activity that will take you a significant amount of
time, e.g. implementing a new feature, it's always good to contact us first, time, like implementing a new feature, it's always good to contact us first,
preferably via the [qubes-devel] mailing list. Once we've worked out the preferably via the [qubes-devel] mailing list. Once we've worked out the
details, we'll add you to our [Community-Developed Feature Tracker]. We'll then details, we'll add you to our [Community-Developed Feature Tracker]. We'll then
be grateful to [receive your patch][patch]. be grateful to [receive your patch][patch].

15
basics_user/doc-guidelines.md
View File

@ -16,18 +16,17 @@ dedicated [qubes-doc] repository. By cloning and regularly pulling from
this repo, users can maintain their own up-to-date offline copy of all Qubes this repo, users can maintain their own up-to-date offline copy of all Qubes
documentation rather than relying solely on the Web. documentation rather than relying solely on the Web.
The documentation is a community effort in which volunteers work hard trying to The documentation is a community effort. Volunteers work hard trying to
keep everything accurate and comprehensive. If you notice a problem with the keep everything accurate and comprehensive. If you notice a problem with the
documentation or some way it can be improved, please [report] it! Better documentation or some way it can be improved, please [report] it! Better
yet, you can [edit the documentation][contribute] yourself, both to add new yet, you can [edit the documentation][contribute] yourself, both to add or improve existing content.
content and to edit existing content.
How to Report Issues How to Report Issues
-------------------- --------------------
To report an issue, please create an issue in [qubes-issues], but before you do, To report an issue, please create one in [qubes-issues], but before you do,
please make sure your issue does **not** already exist. Documentation-related please make sure it does **not** already exist. Documentation-related
issues will be assigned the `doc` label. Issues which have been created in issues will be assigned the `doc` label. Issues which have been created in
[qubes-issues] are significantly more likely to be addressed than those sent in [qubes-issues] are significantly more likely to be addressed than those sent in
emails to the mailing lists or to individuals. emails to the mailing lists or to individuals.
@ -79,7 +78,7 @@ they'll be formatted by clicking the "Preview changes" tab.
![edit](/attachment/wiki/doc-edit/06-edit.png) ![edit](/attachment/wiki/doc-edit/06-edit.png)
Once you're finish, describe your changes at the bottom and click "Propose file Once you're finished, describe your changes at the bottom and click "Propose file
change". change".
![commit](/attachment/wiki/doc-edit/07-commit-msg.png) ![commit](/attachment/wiki/doc-edit/07-commit-msg.png)
@ -111,10 +110,10 @@ Contribution Suggestions
* If you find any inaccuracies in the documentation, please correct them! * If you find any inaccuracies in the documentation, please correct them!
* If you find an inaccuracy but don't know how to correct, you can still help * If you find an inaccuracy but don't know how to correct it, you can still help
by documenting the inaccuracy. For example, if you have *thoroughly* tested by documenting the inaccuracy. For example, if you have *thoroughly* tested
a set of steps in the documentation and know *for certain* that they no a set of steps in the documentation and know *for certain* that they no
longer work on a certain version of Qubes (e.g., because the steps are longer work on a certain version of Qubes (maybe because the steps are
out-of-date), then please add a note to the documentation indicating this. out-of-date), then please add a note to the documentation indicating this.
You may also wish to provide a link to a relevant thread on the [mailing You may also wish to provide a link to a relevant thread on the [mailing
lists]. lists].