Commit Graph

69 Commits

Author SHA1 Message Date
Andrew David Wong
0e3d60937c
Add note about backports 2021-08-10 00:37:00 -07:00
Andrew David Wong
b77b277b73
Add FAQ entry about not fixing all upstream bugs
This topic seems to come up frequently enough to merit an FAQ entry. The
most recent example is https://github.com/QubesOS/qubes-issues/issues/6825#issuecomment-895266155,
but it is by no means the first.
2021-08-10 00:16:03 -07:00
Andrew David Wong
54525b2e09
Update links; fix typo 2021-07-20 03:27:51 -07:00
Andrew David Wong
ca0ccab949
Update titles and links 2021-07-10 14:25:29 -07:00
Andrew David Wong
a18174dc5e
Fix capitalization; update terms (QubesOS/qubes-issues#6769)
Thank you to @unman for the initial sentence case pass.
2021-07-09 05:10:44 -07:00
unman
d0bc9e70a2
Sentence case for titles 2021-07-09 01:06:41 +00:00
Andrew David Wong
c29cf40910
Reorganize doc guidelines into multiple pages; update style guide
The existing doc guidelines page attempts to combine too many different
topics at once and includes information that does not pertain directly
to the documentation. This reorganization is intended to make each type
of information easier to find. For example, some have found it difficult
to find the documentation style guidelines (see, e.g.,
QubesOS/qubes-issues#6701#issuecomment-875875610). This reorganization
allows us to assign more specific titles to each page.

General changes:
- Create new page for contribution instructions
- Create new page for website style guide
- Create new page for continuous integration
- Rename existing "style guide" to "visual style guide" in order to
  avoid ambiguity with new doc and website style guides
- Retain existing page solely for doc style guide
- Update page names and permalinks
- Update existing links
- Improve language

Doc style guide changes:
- Add section on using sentence case in headings
  (see QubesOS/qubes-issues#6756 and #1173)
- Improve section organization
- Clarify language

In order to better preserve the Git history of each file, file renames
will be handled in a separate commit.
2021-07-08 08:08:57 -07:00
Andrew David Wong
440ca6a597
Update Whonix links; add Privacy Policy links 2021-07-05 05:26:21 -07:00
Marek Marczykowski-Górecki
3806ecf338
Remove extra newlines at the beginning/end of files
Those are redundant, and yaml parser strips them in fact. By removing
them, loading and saving yaml file without any change indeed produce the
same output. This is useful for prepare_for_translation.py script (which
adds lang and ref tags) - to produce only change that indeed was made.
2021-06-24 16:07:23 +02:00
Andrew David Wong
527a2eb339
Update links 2021-06-21 00:38:18 -07:00
Andrew David Wong
ea0a14fb7a
Update OS names 2021-06-19 02:24:52 -07:00
Andrew David Wong
e451f92cde
Update attachment paths 2021-06-18 05:46:02 -07:00
Andrew David Wong
60bd80ad25
Revert "Update attachment paths"
This reverts commit e5a21f7488.
2021-06-18 05:39:47 -07:00
Andrew David Wong
e5a21f7488
Update attachment paths 2021-06-18 05:02:02 -07:00
Andrew David Wong
e26e40cdc5
Replace "TemplateVM" with "template"; fix links
QubesOS/qubes-issues#1015
2021-06-18 03:37:30 -07:00
Andrew David Wong
88a4e0a4b5
Fix links 2021-06-18 02:59:26 -07:00
Andrew David Wong
be1d9649bd
Merge branch 'patch-1' of https://github.com/SvenSemmler/qubes-doc into SvenSemmler-patch-1 2021-06-17 22:55:51 -07:00
Andrew David Wong
a31ee53024
Minor improvements 2021-06-17 22:55:06 -07:00
Andrew David Wong
07bf7884fb
Improve language and accuracy 2021-06-17 22:53:47 -07:00
Sven Semmler
e294b0eb4c
Where to install software
Based on https://qubes-os.discourse.group/t/software-will-install-then-doesnt-save-and-cant-be-found-this-is-not-a-disposable-vm-plenty-of-space/4634/1 ... seen this a lot lately and thought it's time for an FAQ entry.
2021-06-17 18:16:47 -05:00
Andrew David Wong
76150ac9d3
Fix links 2021-06-17 07:01:53 -07:00
Andrew David Wong
12408884dd
Clean up YAML titles and create redirect stubs
QubesOS/qubes-issues#6701
2021-06-17 02:40:43 -07:00
Andrew David Wong
2c473241a8
Revert "Remove all instances of permalink: in YAML frontmatter"
This reverts commit c815e4c54c.

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862822827
2021-06-16 19:56:25 -07:00
Andrew David Wong
0c95b3ae4d
Revert "Remove instances of title: from YAML headers"
This reverts commit 24e6a8a616.

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:19:45 -07:00
Andrew David Wong
c815e4c54c
Remove all instances of permalink: in YAML frontmatter
Converts existing permalink paths into redirect_from entries.

QubesOS/qubes-issues#6701
2021-06-15 22:33:51 -07:00
Andrew David Wong
24e6a8a616
Remove instances of title: from YAML headers
QubesOS/qubes-issues#6701
2021-06-15 22:16:59 -07:00
herypt
8a8178db0d
Remove Flash documentation 2021-05-14 14:08:12 +02:00
Tobias Killer
bcbeae7463
Resolve open issues mentioned on Transifex 2021-04-17 11:03:50 +02:00
Tobias Killer
098f5b418c
Resolve open issues mentioned on Transifex 2021-04-17 10:57:16 +02:00
Tobias Killer
6b33020140
Resolve open issues mentioned on Transifex 2021-04-17 10:45:27 +02:00
Tobias Killer
b6cb04c297
Refactor links in order to obey the new convention rule 2021-04-11 00:09:05 +02:00
Maya
820af56761
Add lang + ref tags to frontmatter
Those are fields used by the language switcher to correlate pages across
different languages, even if they have different names/paths/titles.
They are generated with the prepare_for_translation.py script.
2021-03-14 16:18:11 +01:00
Maya
8f8a8e50ea
Normalize frontmatter
- sort keys
- remove permalink from redirects
2021-03-14 16:18:10 +01:00
Maya
67a92614aa
Markdown formatting fixes
- mark all code blocks with ```
- unify empty lines between sections
- adjust list syntax (no space before dash)
- adjust headers to use Atx-style syntax
- remove trailing spaces
2021-03-14 16:18:10 +01:00
Andrew David Wong
39b6f3b871
Merge branch 'hardware-troubleshooting' of https://github.com/PROTechThor/qubes-doc into PROTechThor-hardware-troubleshooting 2021-02-15 04:29:42 -08:00
Andrew David Wong
1ced4e11d9
Merge branch 'faq-opengl' of https://github.com/AlxHnr/qubes-doc into AlxHnr-faq-opengl 2021-01-05 16:03:00 -08:00
Robin Schneider
ec70076361
Use HTTPS everywhere (mechanical edit using util from https-everywhere)
Ref: https://github.com/EFForg/https-everywhere/tree/master/utils/rewriter

```Shell
~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js .
```
2020-12-19 19:57:07 +01:00
Andrew David Wong
2fa0fad4bc
Minor edit 2020-12-16 17:10:05 -08:00
Alexander Heinrich
b835c340b3 Reword section concerning GPU virtualization 2020-12-16 11:36:35 +01:00
Andrew David Wong
d201a09b9a
Update links to Qubes-Community version
https://github.com/QubesOS/qubes-issues/issues/4693
2020-12-07 22:31:41 -08:00
Andrew David Wong
30e7112f4a
Convert absolute to relative links
Absolute links break automatic onion redirection:
https://groups.google.com/g/qubes-users/c/NJdzP27wvmM/
2020-12-07 17:04:29 -08:00
Andrew David Wong
0a27688e51
Merge branch 'update-troubleshooting' of https://github.com/PROTechThor/qubes-doc into PROTechThor-update-troubleshooting 2020-11-25 04:20:18 -08:00
Andrew David Wong
233e45ba71
Update entry on VT-x/AMD-V importance 2020-11-21 08:02:28 -08:00
Andrew David Wong
48a2a2b037
Update FAQ entries with respect to system requirements
- Remove outdated information
 - Generalize references to specific versions
 - Fix grammar and orthography
2020-11-21 06:58:21 -08:00
PROTechThor
8e06262d7a Add Update Troublshooting, edit VM TS 2020-11-21 00:20:47 +01:00
PROTechThor
ce3618cfc0 Add Hardware Troubleshooting 2020-11-14 18:30:58 +01:00
Andrew David Wong
5584721fbb
Merge branch 'qubes-is-slow' of https://github.com/PROTechThor/qubes-doc into PROTechThor-qubes-is-slow 2020-10-28 23:33:27 -07:00
Enjeck Cleopatra
f8b6b5fe97 Add new FAQ 2020-10-28 05:34:48 +01:00
Andrew David Wong
0e5a97785c
Add information about doc review security 2020-10-27 19:23:57 -07:00
PROTechThor
e9d2c7a655 Fix links 2020-10-26 04:22:27 +01:00