Commit Graph

182 Commits

Author SHA1 Message Date
Andrew David Wong
41cdc59afd
Change mailing list posting policies due to excessive spam 2021-09-24 10:18:17 -07:00
Andrew David Wong
1263636075
Add link to "bug priorities" section 2021-09-06 22:51:30 -07:00
deeplow
81c1821ced
fix typo 2021-08-15 00:19:25 +00:00
Andrew David Wong
504ff2f798
Minor clarifications 2021-08-13 03:13:52 -07:00
Andrew David Wong
c1bf45c49d
Update milestone names; standardize orthography 2021-08-11 04:21:53 -07:00
Andrew David Wong
c2182743fa
Update new issue instructions to account for simplified template 2021-08-11 04:11:30 -07:00
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