I submitted #1191 previously but then had already purged my local fork. So I was unable to change it (if there is a way I am oblivious to it). Hence I closed#1191 and opened this pull request in it's place. Sorry for that.
Per Andrew's comment, made updates. I did not want to follow the styleguide 1:1, literally—as a user viewing mostly redundant text is more likely to visually recognize the redundancy and skip past it, without making the effort to see deviations.
Per https://github.com/QubesOS/qubes-issues/issues/#6871 added a blurb in the CLI section, to advise users that 1. The terminal in the update-vm will in fact open, and 2. Where the logs will be saved to. My notation on two may be incorrect, so pls check?
- Add requirement that certified devices must be available for purchase
with Qubes OS preinstalled. See: https://forum.qubes-os.org/t/5795/
- Improve wording
- Add link to HCL in intro
- Wrap text
This won't break the URLs. They'll just automatically redirect to the
correct thread. This will allow us to keep updating and re-using the
same thread and URL without scaring off users who see "r4-0-4" in the
URL and think it's out-of-date in the future.
Link to the forum post with the community created "just works" list for R4.0.4; also added the respective CPU info the the testing hardware retrieved from @marmarek
I'm still not sure why these files have to be in qubes-doc in order to
appear in the doc index, but they do, so I'm moving them back even
though they're mostly empty.
In general, the software world is not clear about these terms. However,
the most common usage seems to use "point release" to refer to any
release with at least one period in the version number, which would also
include minor releases. By contrast, "patch release," though a much less
common phrase, unambiguously denotes a release with a version number
containing two periods.
See:
https://en.wikipedia.org/wiki/Point_releasehttps://semver.org/
- Improve language
- Fix image links
- Explain BIOS and UEFI, provide links
- Fill in missing steps and information gaps
- Standardize grammar and punctuation
- Improve formatting
- Clarify instructions and explanations
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.
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.
- Document template testing repos
- Introduce dom0 testing repos
- Cross-link dom0 and domU testing repo sections
- Link to template testing section from related sections
- Add pointer to installing templates
- Minor improvements and fixes
Thanks to @GWeck for pointing out the need for this in:
https://forum.qubes-os.org/t/fedora-34-template-available-for-testing/4904/4
Remove use of the phrase "GUI" and specifically speak to the "Devices WIdget." Especially since it is now referenced in the Getting Started section, which should cross-link, here.
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.
- Add and update links
- Update terminology
- Fix and improve syntax
- Clarify command-line variables
- Fix headings
- Improve language
- Make syntax consistent
- Remove deprecated and inaccurate information
- Improve grammar and orthography
- Fix typos
- Wrap text
Related to #1164
- Create new "Command-line interface" section
- Move warning about direct commands to new section
- Move info about qubesctl commands and testing repos to new section
- Revise "Upgrading" section
- Improve intro
- Make key instruction steps harder to miss
- Add "Troubleshooting" section
- Move text on updating standalones to "Standalones and HVMs"
Based on examining the AwesomeWM project's web presences and Wikipedia
entry, there does not appear to be a single consistent name by which the
project refers to its window manager. All three of these variations are
used: "awesome", "Awesome", and "AwesomeWM". In order to avoid ambiguity
with the regular English word, we're opting for "AwesomeWM" in our own
documentation.
This commit also reverts the change to the widget image, since that
change was not necessary (see #1161).
Finally, this commit adds links to the KDE, i3, and AwesomeWM pages.
- Updated image to match wording to names shown above
- Edited "custom" to "unique" wrt "unique to qubes," as sdwdate is not custom _to_ qubes, but is unique(ish) to Qubes.
- Included bullet for Whonix widget, w/ link-out
- Capitalized "A" on Awesome in desktop environments
- Convert alert into text warning
(Now that every advanced page has the same sticky alert at the top,
it looks odd to have similar alerts above and below the h1 heading.)
- Update heading syntax
- Wrap text
- Convert alert into text warning
(Now that every advanced page has the same sticky alert at the top,
it looks odd to have similar alerts above and below the h1 heading.)
- Fix headings
- Fix syntax
- Wrap text
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.
- Mark as advanced page
- Revise introduction
- Move list of available templates to new section
- Clarify installation commands
- Fix language and syntax errors
- Wrap text
- Explicitly state that software should be installed in a template
- Add a note for advanced users who might be interested in installing
software in standalones and dom0
- Fix Markdown syntax and formatting
- Wrap text
- Replace "VM" with "qube" (QubesOS/qubes-issues#1015)
- Remove deprecated terms
- Remove some terms that are not Qubes-specific
- Alphabetize entries
- Miscellaneous improvements
