Commit Graph

48 Commits

Author SHA1 Message Date
Marek Marczykowski-Górecki
5c4ba856ae
Merge remote-tracking branch 'origin/pr/395' into https
* origin/pr/395:
  Update devel-faq.md
2017-05-06 23:38:02 +02:00
Marek Marczykowski-Górecki
408b818a0e
Merge remote-tracking branch 'origin/pr/393' into https
* origin/pr/393:
  Update coding-style.md
2017-05-06 23:38:02 +02:00
Marek Marczykowski-Górecki
9919e153bb
Merge remote-tracking branch 'origin/pr/356'
* origin/pr/356:
  Fixed inaccuracy
  Rewrite 'Why does dom0 need to be 64-bit"
2017-05-06 01:20:28 +02:00
InstantGratimification
9c80ebcb96 Update devel-faq.md 2017-05-03 14:38:25 +00:00
InstantGratimification
736ca29d02 Update coding-style.md 2017-05-03 14:35:21 +00:00
InstantGratimification
ec5858f642 Update coding-style.md 2017-05-03 10:07:35 +00:00
Dean V
049905736c Fixed inaccuracy 2017-05-02 12:48:14 -07:00
stubbybubby
d4dfff52e8 Rewrite 'Why does dom0 need to be 64-bit"
In order to prevent what happened last time, I'm going to edit this document piecemeal so you can choose which PRs to accept and which to reject.

* Partitioned run on sentences
* Cleaned up wording.
* Newline at end of sentences.
2017-04-17 09:26:10 -07:00
stubbybubby
21232dd492 Update to guidelines, remove some parentheses
Removed some unnecessary parentheses around entire sentences and completely relevant clauses. Also expanded the Using PGP with Email section to provide more detail.

Also made newlines at the end of sentences as per the doc guidelines.
2017-04-16 12:36:17 -07:00
Andrew David Wong
e25f8d831c
Merge branch 'patch-3' of https://github.com/stubbybubby/qubes-doc into stubbybubby-patch-3 2017-04-04 21:54:35 -07:00
stubbybubby
32f2dd64cd Fixed grammar mistake 2017-04-04 16:13:11 -07:00
Andrew David Wong
0177d6fc81
Merge branch 'patch-5' of https://github.com/stubbybubby/qubes-doc into stubbybubby-patch-5 2017-04-02 21:11:41 -07:00
stubbybubby
3db69ad702 Rewrite parts of usability-ux.md
This proposed file changes probably includes some content changes, but ones I hope you'll immediately agree with because the result is a more accurate article.

Among other things,
* Removed unnecessarily prudent logical connection phrases like "thus," and just replaced them with "because" and "as a result" where I could.
* Moved some sentences or clarifications to their proper sections, e.g. moved the "Despite this rule, some acronyms..." line to the Avoid Acronyms section.
* Removed some sentences (like "Additionally, security focused software has the responsibility of providing safety to the user and their data") that, while true, without proper context did not seem relevant to the article.
* Removed some phrases that repeated known contextual information like "of usability and experience" in "if you are interested in furthering your understanding of usability and experience" or "which are shown to a user" in "notifications which are shown to a user".
* Introduced some clauses or phrases that clarified information, like adding "of those mentioned" to "All three desktop environments have their own human interface guidelines,"
* Merged the Avoid Repetitive Tasks and Minimize Repetitive Steps sections.
* Rewrote some sentences that were incomplete or didn't make sense into what I assumed the writer intended to say.
* Inserted possessive's' when they were necessary, and turned bigger sentences into smaller ones using possessives when I could ("notification messages presented to user" --> "user's notification messages")
* Grammar edits
* Compartmentalized run-on sentences.

This was a pretty big edit, so you'll probably disagree with some of the changes. Just explain what you want to be re-done or where my edits changes an important meaning/formed an inaccuracy and I will make another commit.
2017-04-02 11:57:54 -07:00
stubbybubby
49957fc5d7 Minor fix of missing article
"contributed majority of Qubes-specific code" --> "contributed the majority of Qubes-specific code"
2017-04-02 10:46:49 -07:00
stubbybubby
99a5879734 Fix minor grammar issues
Inserted apostrophe's' when necessary and fixed the placement of a few conjunctions.
2017-04-02 10:38:16 -07:00
Andrew David Wong
e2f94ef3f7
Merge branch 'patch-2' of https://github.com/stubbybubby/qubes-doc into stubbybubby-patch-2 2017-03-31 15:03:47 -07:00
stubbybubby
99a8a989ee Remove polarizing 'uneducated'
Removed the word 'uneducated' from a line, in order to prevent the underlying meaning of the section from being changed.
2017-03-30 21:13:03 -07:00
stubbybubby
1f556ca16a Fix spelling mistake and meaning change.
Fixing a spelling mistake of lackadaisical in earlier patch and the unintended change of meaning in last sentence in Rationale.
2017-03-30 21:06:29 -07:00
stubbybubby
8d0fbc14c5 Edit grammar and sentence structure in "G.T.C."
I did not modify any of the content itself; just presented it more clearly by:

- Modifying unnecessarily wordy phrases 
- Fixing grammatical mistakes
- Partitioning run-on sentences
- Reduced Word Re-use
- Removed unnecessary commas
- Formatted each individual typographic convention consistently
- Made misc. changes to improve clarity and make the text more evocative
2017-03-29 22:12:06 -07:00
stubbybubby
afa0c5c6e2 Edit grammar and sentence structure in "Rationale"
I did not modify any of the content itself; just presented it more clearly by:

- Modifying unnecessarily wordy phrases 
- Fixing grammatical mistakes
- Partitioning run-on sentences
- Reduced Word Re-use
- Made misc. changes to improve clarity and make the text more evocative
2017-03-29 21:55:49 -07:00
Andrew David Wong
eb12a38171
Move pages on user-contributable areas to user docs 2017-03-20 18:39:04 -07:00
Andrew David Wong
f6ff56250d
Add section linking to new testing page 2017-03-20 18:34:36 -07:00
Andrew David Wong
a60f463fe0
Link new testing page to contributing page 2017-03-20 18:34:05 -07:00
Andrew David Wong
634064c8ab
Create page about testing new releases and updates 2017-03-20 18:33:08 -07:00
Valentin Heinz
2f1b18c5c3 Update devel-books.md
Fixed link.
2017-03-18 10:00:36 +01:00
Andrew David Wong
afffe66573
Update Markdown conventions
QubesOS/qubes-issues#1452
Closes QubesOS/qubes-issues#2639
2017-02-18 23:18:11 -08:00
Andrew David Wong
ab474ee5d2
Add dev FAQ entry: QEMU is not part of the TCB 2017-02-16 19:27:15 -08:00
Andrew David Wong
764cbe1946
Remove "Q:" prefixes 2017-02-16 18:56:19 -08:00
Jean-Philippe Ouellet
719384599d Document how to copy info out of Dom0
Final step for the following:

Fixes: https://github.com/QubesOS/qubes-issues/issues/2450
Fixes: https://github.com/QubesOS/qubes-issues/issues/2464
Follows: https://github.com/QubesOS/qubes-doc/pull/246
Follows: https://github.com/QubesOS/qubes-manager/pull/15
Follows: https://github.com/QubesOS/qubes-attachment/pull/12
Reminded-by: https://groups.google.com/forum/#!topic/qubes-devel/Wlyt16_yKow
2017-02-11 15:57:29 -05:00
Andrew David Wong
4947dd1a2f
Create "Contribution Suggestions" section 2017-01-23 04:29:55 -08:00
Claude Hemberger
4a26e234ca Contributing document link fix
The link to the current github issues with the help wanted tag was pointing to page 3 of the results.
2017-01-14 17:09:07 +01:00
Andrew David Wong
6d4d8d374e
Update FAQ about "respecting distro culture"
https://github.com/QubesOS/qubes-issues/issues/2006#issuecomment-269103453
2016-12-25 01:32:50 -08:00
Jean-Philippe Ouellet
52e8bdbc42 Move git commit guidelines to coding style section
instead of only in docs section, and link to it from original location.
2016-12-11 04:35:12 -05:00
Jean-Philippe Ouellet
e535198d67
Use https for Amazon links 2016-11-28 03:30:51 -05:00
Jean-Philippe Ouellet
8616ee746e
Update Amazon book link to current edition
"Linux Kernel Development" by Robert Love -> 3rd edition
2016-11-28 03:28:44 -05:00
Jean-Philippe Ouellet
3ffc891057
Add note to prefer using GTK over Qt for new GUIs
See https://groups.google.com/forum/#!topic/qubes-devel/2pWolRF3otY
for discussion of why.
2016-11-22 01:21:56 -05:00
Andrew David Wong
1ff02d4a01
Add sending/receiving patches to Contributing Code 2016-11-19 23:18:19 -08:00
Andrew David Wong
0aeeae803d
Fix links 2016-11-19 23:08:45 -08:00
Andrew David Wong
969400fe7d
Link to Contributing Code 2016-11-19 22:54:27 -08:00
Andrew David Wong
5245e53f6b
Rewrite Reporting Bugs page
* Organize sections logically according to each step in the bug
  reporting process
* Explain how bugs can be reported in different venues
* Explain how to report bugs in qubes-issues (will replace
  CONTRIBUTING.MD)
* Link to Contributing page
* Generally improve wording and formatting
2016-11-19 22:51:00 -08:00
Andrew David Wong
c9b06e8b42
Rewrite Contributing page
* List all of the main ways in which people can contribute
* Provide helpful links for each of those ways
* Explain how to contribute code
* Provide helpful links to source code, how to send patches, reporting
  bugs, etc.
* Improve wording and formatting in general
2016-11-19 22:45:57 -08:00
Andrew David Wong
7d035ef518
Update patch submission instructions
* Mention benefits of GitHub PRs
* Suggest sending message to qubes-devel in addition to PR
* Update link to qubes-devel
2016-11-19 21:28:36 -08:00
Andrew David Wong
732ba9334c
Add FAQ entry on respecting distros' culture
See discussion on QubesOS/qubes-issues#1014.
2016-11-15 00:31:43 -08:00
Michael Carbone
d77c58b6c7 make more inviting, improve language
I modified it to get it closer to [best practices for contributing pages](https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-template.md)
2016-11-13 16:12:58 -05:00
Andrew David Wong
3f5c670d6d
Remove deprecated portion on KDE 2016-10-24 01:40:07 -07:00
Andrew David Wong
de7e886787
Update bug reporting page
* Distinguish security issues from bugs and add link to information
  on reporting security issues
* Add link to Mailing Lists page in place of direct link to Google
  Groups web interface
* Add common redirects
2016-10-23 00:56:22 -07:00
Andrew David Wong
749ce71d56
Redirect old System Doc to new Developer Docs section 2016-10-19 16:13:51 -07:00
Andrew David Wong
aadb35d62f
Move all developer documentation to main index
QubesOS/qubes-issues#2070
2016-06-20 13:56:20 -07:00