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
79e359e153
Clarify scope with respect to official vs. unofficial venues
...
The need for this clarification became apparent in:
https://forum.qubes-os.org/t/comments-from-staff-core-team-etc-regarding-facebook-group/5433/
2021-08-02 09:06:37 -07:00
Andrew David Wong
54525b2e09
Update links; fix typo
2021-07-20 03:27:51 -07:00
Dave Smith
d01ad9c33e
Fix htmlproofer errors in PRs #1176 & #1177...
...
caused by hcl.md file rename in qubes-doc commit 7d894a59
2021-07-16 01:15:15 -05: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
41ed804361
Wrap text; improve wording
2021-07-05 05:35:57 -07:00
Andrew David Wong
440ca6a597
Update Whonix links; add Privacy Policy links
2021-07-05 05:26:21 -07:00
Andrew David Wong
65c3dd0f5e
Update "Issue Tracking"
...
- Reorder sections (https://github.com/QubesOS/qubes-doc/pull/1170#issuecomment-874019640 )
- Add explanatory text
- Improve wording
- Append periods to complete declarative sentence headings
2021-07-05 05:05:56 -07:00
Andrew David Wong
9bb8a55ef2
Use Markdown syntax instead of HTML
...
Although the HTMl tags are technically correct, it's probably more
important to preserve source readability and avoid the problems that
HTML-in-Markdown poses for localization and offline documentation.
2021-07-05 04:48:29 -07:00
Andrew David Wong
779f3c4342
Append periods to complete declarative sentence headings
2021-07-05 04:44:48 -07:00
Andrew David Wong
5d9fa09ad4
Update "Help, Support, Mailing Lists, and Forum"
...
- Reorder sections (https://github.com/QubesOS/qubes-doc/pull/1170#issuecomment-874019640 )
- Improve wording of "where to discuss Qubes" section (#1170 )
- Add links to discussion guidelines
2021-07-05 04:40:24 -07:00
Andrew David Wong
bae794951d
Capitalize second word in title case compound adjectives
...
https://github.com/QubesOS/qubes-issues/issues/6756#issuecomment-873385039
2021-07-04 03:35:59 -07:00
Andrew David Wong
5220089b53
Update references to "Getting Started"
...
QubesOS/qubes-issues#6756
2021-07-03 03:46:27 -07:00
Andrew David Wong
fcc90a5908
Change title back to "Getting Started"
...
QubesOS/qubes-issues#6756
2021-07-03 03:42:25 -07:00
Andrew David Wong
ca109b05c7
Change name back to "Getting Started" and move to intro
...
QubesOS/qubes-issues#6756
2021-07-03 03:40:13 -07:00
Andrew David Wong
a5a4f16fbd
Update Qubes Forum URL
2021-07-01 06:59:37 -07:00
Marek Marczykowski-Górecki
4017d11de3
Run script to add 'ref' parameters
2021-06-24 18:19:05 +02: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
ed6275bf8b
Revamp "Video Tours"
...
- Remove unnecessary filler links
- Use Markdown, since HTML is not necessary here
- Make videos responsive
- Other miscellaneous improvements
2021-06-23 16:20:54 -07:00
Andrew David Wong
6cc2f9932b
Update QSB page link
2021-06-22 10:50:12 -07:00
Andrew David Wong
7b1c4c6938
Fix typos; tweak wording
2021-06-22 10:40:02 -07:00
Andrew David Wong
f9461579a7
Rename layout "default" to "site"
2021-06-22 01:26:14 -07:00
Andrew David Wong
09a5ec7ffb
Update "Video Tours"
2021-06-21 22:52:24 -07:00
Andrew David Wong
308fadf650
Improve language and links
2021-06-21 18:50:25 -07:00
Andrew David Wong
a015f60087
Fix links
2021-06-21 18:39:21 -07:00
Andrew David Wong
bf7c44536b
Update mailing list info
...
- Further emphasize that Google accounts are not required
- Prioritize traditional mail archive links ahead of Google Groups
2021-06-21 03:21:22 -07:00
Andrew David Wong
b02f6ade06
Fix typo
2021-06-21 03:11:21 -07:00
Andrew David Wong
1ecad8cd03
Update text
2021-06-21 03:01:17 -07:00
Andrew David Wong
0701f196c8
Update "Help, Support, Mailing Lists, and Forum"
...
- Revamp intro to make it (hopefully) more user-friendly
- Generalize last section into "Unofficial venues"
- Warn that we do not monitor or moderate unofficial venues
- Warn more explicitly about possible Qubes team impostors
- Miscellaneous updates and improvements
2021-06-21 02:55:53 -07:00
Andrew David Wong
0c3c2aa82d
Update "Issue Tracking"
...
- Improve section organization
- Improve new issue instructions
- Add section on "projects"
- Convert final section into "How issues get closed"
- Add section on backports (closes QubesOS/qubes-issues#6655 )
2021-06-21 01:43:38 -07:00
Andrew David Wong
527a2eb339
Update links
2021-06-21 00:38:18 -07:00
Andrew David Wong
f860726c93
Rename file to match new title
2021-06-21 00:31:01 -07:00
Andrew David Wong
60a894bded
Revamp "Reporting Bugs and Other Issues"
...
- Rename to "Issue Tracking" (file rename in separate commit to preserve
history)
- Break the "Important" section up into multiple shorter sections in an
attempt to discourage people from skipping over it
- Add "How to open a new issue" section
- Add "Labels and milestones" section
- Update heading syntax
2021-06-21 00:28:42 -07:00
Andrew David Wong
dec4c71a79
Update button to match page title
2021-06-20 22:29:11 -07:00
Andrew David Wong
b8ffe76d54
Update and fix links
2021-06-19 21:47:40 -07:00
Andrew David Wong
b88fe1d32d
Rename *.html files to *.md
...
This eases the doc maintenance burden by allowing bulk operations on
*.md files without missing intended files (whereas attempting to perform
such operations on *all* files can be dangerous due to hidden git files,
for example). Since HTMl can validly be embedded in Markdown files, this
doesn't affect the way the pages are rendered.
2021-06-19 21:35:44 -07:00
Andrew David Wong
3676c18bdb
Move experts.md to main website repo
...
This file contains no content anymore, and it's not documentation.
2021-06-19 20:42:03 -07:00
Andrew David Wong
2dbc8865e1
Use doc layout instead of sidebar layout
...
There appears to be no strong reason that these pages are using a
different layout, and having this separate layout significantly
increases the ongoing doc maintenance burden.
2021-06-19 20:39:34 -07:00
Andrew David Wong
ea0a14fb7a
Update OS names
2021-06-19 02:24:52 -07:00
Andrew David Wong
325abc8cc3
Fix typo
2021-06-18 07:33:55 -07:00
Andrew David Wong
679c54e056
Update privacy.md
2021-06-18 07:31:09 -07:00
Andrew David Wong
d3e74d5c0b
Update retention period
2021-06-18 06:26:23 -07:00
Andrew David Wong
07c130df00
Wrap text and miscellaneous cleanup
2021-06-18 06:25:06 -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
ce031173f0
Fix links and update terms
...
QubesOS/qubes-issues#1015
2021-06-18 03:12:22 -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
19c5334ff8
Fix typo
2021-06-17 11:20:30 -07:00
Andrew David Wong
7d3fd4fa26
Create general Privacy Policy; add mirror note
...
Based on @unman's proposal:
c52aaa6821https://qubes-os.discourse.group/t/qubes-website-privacy-policy/2235/
2021-06-17 11:06:21 -07:00
Andrew David Wong
08eb959f6f
Add FAQ entry on data use
...
https://qubes-os.discourse.group/t/qubes-website-privacy-policy/2235/
2021-06-17 08:04:14 -07:00
Andrew David Wong
2d0cbc0991
Add FAQ entry on data retention
...
https://qubes-os.discourse.group/t/qubes-website-privacy-policy/2235/
2021-06-17 08:02:21 -07:00
Andrew David Wong
76150ac9d3
Fix links
2021-06-17 07:01:53 -07:00
Andrew David Wong
6d81f95cc2
Update and reorganize documentation
...
- Convert "Common Tasks" to "How-to Guides"
(QubesOS/qubes-issues#6694 )
- Make title capitalization consistent across docs
- Fix leftover h1 headings
- Reorganize various pages and topics
- Update permalinks to better match titles
- Create redirects for changed permalinks
- Miscellaneous cleanup
QubesOS/qubes-issues#6701
2021-06-17 05:16:22 -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 c815e4c54chttps://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862822827
2021-06-16 19:56:25 -07:00
Andrew David Wong
8f2efb70cb
Remove redundant h1 heading
...
QubesOS/qubes-issues#6701
2021-06-16 03:10:21 -07:00
Andrew David Wong
a4cbb51092
Remove vestigial '====' heading syntax
...
https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:53:27 -07:00
Andrew David Wong
f822b70435
Remove redundant titles
...
First pass for all titles still using the old '=====' syntax
https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:48:48 -07:00
Andrew David Wong
0c95b3ae4d
Revert "Remove instances of title: from YAML headers"
...
This reverts commit 24e6a8a616https://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
Andrew David Wong
e1f929b0ca
Move issue template guideline up and update wording
2021-05-27 21:33:04 -07:00
Marek Marczykowski-Górecki
759b46fa04
Migrate off freenode
2021-05-26 13:50:01 +02:00
Andrew David Wong
ada8749758
Mention discussion and forum
2021-05-24 02:46:49 -07:00
Andrew David Wong
255f286430
Fix typo
2021-05-23 22:23:18 -07:00
Andrew David Wong
cb68c39f65
Expound on issue tracking guidelines
2021-05-23 21:57:50 -07:00
herypt
8a8178db0d
Remove Flash documentation
2021-05-14 14:08:12 +02:00
deeplow
0d99bbbe31
Update support.md
2021-05-09 10:50:39 +00:00
deeplow
9bd9686a0c
add link to using forum via email
2021-05-09 10:48:59 +00:00
deeplow
c95744e860
add link to instructions on forum via email
2021-05-03 17:29:14 +00:00
Andrew David Wong
3c8c1464e2
Direct users to check docs before asking for help
2021-05-01 03:25:55 -07:00
Andrew David Wong
1dca07f29c
Make forum description more accurate; integrate link
2021-04-27 19:58:54 -07: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
2ae338948a
Repair link
2021-04-11 09:23:35 +02:00
Tobias Killer
5047127350
Merge branch 'master' into md-refactoring-links
2021-04-11 00:44:42 +02:00
Tobias Killer
b6cb04c297
Refactor links in order to obey the new convention rule
2021-04-11 00:09:05 +02:00
Andrew David Wong
84c1cb36ea
Clarify that the issue tracker is not a discussion forum
2021-04-10 08:03:09 -07:00
E. Cleopatra
fafc9cde17
Edit button label
2021-04-02 02:51:37 +01:00
Marek Marczykowski-Górecki
965d495c2c
Remove broken redirect
...
There is no way to redirect _from_ a #href link. The one without # is
already included.
2021-03-30 13:17:15 +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
1a92224f8b
Remove content from pages dynamically filled in by a relevant layout
...
In fact, right now those pages content is duplicated - once included
here and once inserted by the doc-content (or hcl) layout.
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
5310611d88
Fix broken link ( #1114 )
2021-02-26 13:12:30 -08:00
HackerNCoder
5701f5b733
Downgrade images to 4.0
2021-02-16 02:44:31 +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
Andrew David Wong
fafa91bcec
Add section on moderation
...
Discussed in:
https://qubes-os.discourse.group/t/deletion-policy/2099/
2021-01-03 08:27:39 -08:00
