Commit Graph

94 Commits

Author SHA1 Message Date
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 c815e4c54c.

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862822827
2021-06-16 19:56:25 -07:00
Andrew David Wong
de77a013b2
Rename files to match reorg
QubesOS/qubes-issues#6701
2021-06-16 00:33:57 -07:00
Andrew David Wong
4ff7430960
Remove redundant h1 titles using # syntax
https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-16 00:29:28 -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 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
aca8ed14c7
Normalize instances of redirect_from:
QubesOS/qubes-issues#6701
2021-06-15 22:24:44 -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
4225b651b8
Fix typos 2021-06-14 22:42:19 -07:00
Andrew David Wong
ab8b176c93
Update Security Center intro section
The "Security Goals" page is actually more of a statement of the
developers' security design goals. It does not realy pertain to
*project* security, which is what the "Security Center" page is about,
so I'm moving it to the developer docs (index updated in a separate
commit).
2021-06-14 22:07:36 -07:00
Andrew David Wong
c6e231e885
Capitalize for consistency with other occurrences 2021-06-14 21:50:27 -07:00
Andrew David Wong
f4a0c5575a
Improve QSB and canary pages
- Add general descriptions
- Link to Qubes Security Team
- Add headings for lists
- Normalize heading syntax
2021-06-14 21:33:53 -07:00
Andrew David Wong
57006d3242
Generalize link descriptions for accuracy 2021-06-14 21:08:22 -07:00
Andrew David Wong
c6beef25f5
Improve qubes-secpack page
- Swap section order
- Normalize heading capitalization and syntax
- Add redirect
2021-06-14 20:58:18 -07:00
Tobias Killer
b6cb04c297
Refactor links in order to obey the new convention rule 2021-04-11 00:09:05 +02:00
Marek Marczykowski-Górecki
752f1d4ddc
Fix over indented code blocks 2021-03-28 20:58:39 +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
d054267e84
Define "QSB"
Discussed in:
https://qubes-os.discourse.group/t/safety-when-forced-not-to-use-updater/2085
2021-01-03 08:06:53 -08:00
Andrew David Wong
c9290ec01f
Clarify verification steps 2020-11-21 06:30:42 -08:00
Andrew David Wong
447d3dd310
Add "No such file or directory" FAQ 2020-11-21 06:01:52 -08:00
Andrew David Wong
2062b31502
Add Fedora and Debian methods for acquiring the QMSK
Thanks to Andrew Clausen for the suggestion.
2020-11-14 18:25:13 -08:00
Andrew David Wong
fdcaadaeec
Add info about distribution-gpg-keys; clarify section
Thank you to Andrew Clausen for pointing out this package.
2020-11-14 00:16:13 -08:00
Andrew David Wong
371d5471a5
Remove keyserver and search engine ideas 2020-11-12 22:46:59 -08:00
Andrew David Wong
c9ce37b388
Substitute older mailing list post with key attached 2020-11-12 08:55:51 -08:00
Andrew David Wong
03e6dd2bda
Add more supporting links 2020-11-12 08:53:32 -08:00
Andrew David Wong
cc3b1f82a9
Improve instructions regarding QMSK authentication
Inspired by a forum discussion:
https://qubes-os.discourse.group/t/there-is-no-way-to-validate-qubes-master-signing-key/1441
2020-11-12 08:29:09 -08:00
Andrew David Wong
0bd2db6670
Add documentation links and direct users to read them
QubesOS/qubes-issues#6191
2020-11-07 22:59:55 -08:00
Andrew David Wong
b7821598a3
Add prep section for installing PGP verification programs
This is a first step toward improving the instructions for non-Linux
users (QubesOS/qubes-issues#6191, #1076).
2020-11-06 12:29:42 -08:00
Andrew David Wong
60864a532c
Update qubes-users references to /support/
Now that we have a user forum in addition to qubes-users, it makes more
sense to link to /support/ than to link directly to qubes-users (or to
the forum, for that matter). This layer of redirection means allows us
to update just one thing (namely, the /support/ page) instead of having
to hunt through all the documentation every time support information
changes.
2020-08-22 23:18:08 -05:00
Hans Jerry Illikainen
dfd7e5ebe1
Verify the release key with --check-signatures
The original instructions on how to verify the release signing key used
the `--list-sigs` option for gpg.  However, unlike `--check-signatures`,
the `--list-sigs` option does not verify the authenticity of key
signatures.

See gpg2(1):

    --list-signatures
    --list-sigs
        Same as --list-keys, but the signatures are listed too.
        [...]
        Note that in contrast to --check-signatures the key signatures
        are not verified.
        [...]

    --check-signatures
    --check-sigs
        Same  as  --list-keys, but the key signatures are verified and
        listed too.
        [...]

This updates the documentation to use `--check-signatures` instead.
2020-07-03 12:37:48 +00:00
Andrew David Wong
8b6979fd34
Recommend using gpg2 with keyserver options instead of gpg
Closes QubesOS/qubes-issues#5404
2019-10-23 01:05:50 -05:00
Andrew David Wong
f32c81fab1
Recommend gpg rather than gpg2 due to 2.2.17 changes
Closes QubesOS/qubes-issues#5404
2019-10-20 21:38:13 -05:00
Andrew David Wong
9e9087431e
Add section on security updates 2019-08-26 19:39:40 -05:00
Andrew David Wong
90dc5a26c8
Link to section on copying from dom0 2019-08-18 12:59:33 -05:00
Andrew David Wong
a93b019bef
Point out that release keys are included in Qubes installations
QubesOS/qubes-issues#4292
2019-08-18 12:53:10 -05:00
Andrew David Wong
b38990e666
Point out that the QMSK is already in every Qubes domU
QubesOS/qubes-issues#2544
2019-08-18 12:32:44 -05:00
Andrew David Wong
43a39e35b9
Use default doc layout for project security docs 2019-05-26 20:04:23 -05:00
Andrew David Wong
d31c786942
Reorganize files to account for new "External" section
QubesOS/qubes-issues#4693
2019-05-26 19:32:45 -05:00