mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2025-09-21 21:44:53 -04:00
fixed linter warnings
This commit is contained in:
qubedmaiska
parent
e93ddb3796
commit
1be6e5f9b9
36 changed files with 107 additions and 229 deletions
|
|
@ -72,7 +72,6 @@ Timeline
|
|||
- Final project evaluation and case study
|
||||
|
||||
|
||||
|
||||
Project budget
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
|
|
@ -90,7 +89,6 @@ Project budget
|
|||
- $12,000
|
||||
|
||||
|
||||
|
||||
Additional information
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
|
|
|||
|
|
@ -74,8 +74,7 @@ button to edit the file (if you are already logged in in).
|
|||
|
||||
If you are not logged in you can click on :guilabel:`Sign In`
|
||||
and you’ll be prompted to sign in with your GitHub username and password.
|
||||
You can also create a free account from
|
||||
here.
|
||||
You can also create a free account from here.
|
||||
|
||||
|github-sign-in|
|
||||
|
||||
|
|
|
|||
|
|
@ -123,8 +123,8 @@ The main `qubesos.github.io <https://github.com/QubesOS/qubesos.github.io>`__ co
|
|||
└── pages # ← Stand‑alone pages (donate, team, about, etc.)
|
||||
└── *.md/.html # each file becomes a page at /<filename>/
|
||||
|
||||
How to edit the website
|
||||
-----------------------
|
||||
Cheatsheet
|
||||
----------
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
|
|
@ -139,7 +139,7 @@ How to edit the website
|
|||
- Update the key/value pair, then rebuild.
|
||||
* - Modify the look of all pages
|
||||
- ``_layouts/*.html`` and/or ``_sass/*.scss``
|
||||
- Edit the HTML skeleton or SASS variables, then run ``jekyll serve`` to preview.
|
||||
- Edit the HTML skeleton or SASS variables, then run preview.
|
||||
* - Insert a reusable component (e.g., a call‑out box)
|
||||
- ``_includes/*.html``
|
||||
- Create the snippet, then reference it with ``{% include snippet.html %}`` in any page or post.
|
||||
|
|
|
|||
|
|
@ -574,7 +574,7 @@ Core documentation resides in the `Qubes OS Project’s official repositories <h
|
|||
|
||||
The main difference between **core** (or **official**) and **external** (or **community** or **unofficial**) documentation is whether it documents software that is officially written and maintained by the Qubes OS Project. The purpose of this distinction is to keep the core docs maintainable and high-quality by limiting them to the software output by the Qubes OS Project. In other words, we take responsibility for documenting all of the software we put out into the world, but it doesn’t make sense for us to take on the responsibility of documenting or maintaining documentation for anything else. For example, Qubes OS may use a popular Linux distribution for an official :doc:`TemplateVM </user/templates/templates>`. However, it would not make sense for a comparatively small project like ours, with modest funding and a lean workforce, to attempt to document software belonging to a large, richly-funded project with an army of paid and volunteer contributors, especially when they probably already have documentation of their own. This is particularly true when it comes to Linux in general. Although many users who are new to Qubes are also new to Linux, it makes absolutely no sense for our comparatively tiny project to try to document Linux in general when there is already a plethora of documentation out there.
|
||||
|
||||
Many contributors do not realize that there is a significant amount of work involved in *maintaining* documentation after it has been written. They may wish to write documentation and submit it to the core docs, but they see only their own writing process and fail to consider that it will have to be kept up-to-date and consistent with the rest of the docs for years afterward. Submissions to the core docs also have to :ref:`undergo a review process <developer/general/how-to-edit-the-rst-documentation:security>`__ to ensure accuracy before being merged, which takes up valuable time from the team. We aim to maintain high quality standards for the core docs (style and mechanics, formatting), which also takes up a lot of time. If the documentation involves anything external to the Qubes OS Project (such as a website, platform, program, protocol, framework, practice, or even a reference to a version number), the documentation is likely to become outdated when that external thing changes. It’s also important to periodically review and update this documentation, especially when a new Qubes release comes out. Periodically, there may be technical or policy changes that affect all the core documentation. The more documentation there is relative to maintainers, the harder all of this will be. Since there are many more people who are willing to write documentation than to maintain it, these individually small incremental additions amount to a significant maintenance burden for the project.
|
||||
Many contributors do not realize that there is a significant amount of work involved in *maintaining* documentation after it has been written. They may wish to write documentation and submit it to the core docs, but they see only their own writing process and fail to consider that it will have to be kept up-to-date and consistent with the rest of the docs for years afterward. Submissions to the core docs also have to :ref:`undergo a review process <developer/general/how-to-edit-the-rst-documentation:security>` to ensure accuracy before being merged, which takes up valuable time from the team. We aim to maintain high quality standards for the core docs (style and mechanics, formatting), which also takes up a lot of time. If the documentation involves anything external to the Qubes OS Project (such as a website, platform, program, protocol, framework, practice, or even a reference to a version number), the documentation is likely to become outdated when that external thing changes. It’s also important to periodically review and update this documentation, especially when a new Qubes release comes out. Periodically, there may be technical or policy changes that affect all the core documentation. The more documentation there is relative to maintainers, the harder all of this will be. Since there are many more people who are willing to write documentation than to maintain it, these individually small incremental additions amount to a significant maintenance burden for the project.
|
||||
|
||||
On the positive side, we consider the existence of community documentation to be a sign of a healthy ecosystem, and this is quite common in the software world. The community is better positioned to write and maintain documentation that applies, combines, and simplifies the official documentation, e.g., tutorials that explain how to install and use various programs in Qubes, how to create custom VM setups, and introductory tutorials that teach basic Linux concepts and commands in the context of Qubes. In addition, just because the Qubes OS Project has officially written and maintains some flexible framework, such as ``qrexec``, it does not make sense to include every tutorial that says “here’s how to do something cool with ``qrexec`` in the core docs. Such tutorials generally also belong in the community documentation.
|
||||
|
||||
|
|
|
|||
|
|
@ -17,4 +17,3 @@ Qubes R3.0 release schedule
|
|||
* - 1 Oct 2015
|
||||
- 3.0 release
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -25,4 +25,3 @@ This schedule is based on :ref:`Version Scheme <developer/releases/version-schem
|
|||
* - :strike:`16 Feb 2016` 23 Feb 2016
|
||||
- 3.1-rc3 release
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -28,5 +28,3 @@ This schedule is based on :ref:`Version Scheme <developer/releases/version-schem
|
|||
- 3.2-rc3 release
|
||||
* - 29 Sep 2016
|
||||
- 3.2 release
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -41,4 +41,3 @@ This schedule is based on :ref:`Version Scheme <developer/releases/version-schem
|
|||
* - 28 Mar 2018
|
||||
- final 4.0 release
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -35,4 +35,3 @@ The table below is based on our :ref:`release schedule policy <developer/release
|
|||
* - 2022-02-04
|
||||
- final 4.1.0 release
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -23,4 +23,3 @@ The table below is based on our :ref:`release schedule policy <developer/release
|
|||
* - 2023-10-13
|
||||
- 4.2.0-rc4 release
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -17,4 +17,3 @@ The table below is based on our :ref:`release schedule policy <developer/release
|
|||
* - TBD
|
||||
- 4.3.0-rc1 release
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -54,7 +54,6 @@ The next RC is released five weeks after the former. All packages are published
|
|||
- one week
|
||||
|
||||
|
||||
|
||||
Starting with the second cycle (that is, after ``-rc1``), two weeks into the cycle (after the primary bug-reporting period), we decide whether there should be another RC. If, based on the bugs that have been reported, we decide that the latest RC will be designated as the stable release, then we decide on its release date, which should be no more than one week later.
|
||||
|
||||
|Release cycle|
|
||||
|
|
|
|||
|
|
@ -113,3 +113,4 @@ Conventional means of viewing the memory available to Qubes will give incorrect
|
|||
|
||||
.. |checkmark| image:: /attachment/doc/checkmark.png
|
||||
.. |redx| image:: /attachment/doc/red_x.png
|
||||
|
||||
|
|
|
|||
|
|
@ -68,7 +68,4 @@ And all these components are “glued together” by the Qubes Core Stack.
|
|||
This diagram illustrates the location of all these components in the overall system architecture. Unlike the other Qubes architecture diagram above, this one takes an app-qube-centric approach.
|
||||
|
||||
.. |qubes-schema-v2.png| image:: /attachment/doc/qubes-schema-v2.png
|
||||
|
||||
|
||||
.. |Qubes system components| image:: /attachment/doc/qubes-components.png
|
||||
|
||||
|
|
|
|||
|
|
@ -356,67 +356,24 @@ Getting help
|
|||
|
||||
|
||||
.. |Rufus menu| image:: /attachment/doc/rufus-menu.png
|
||||
|
||||
|
||||
.. |Rufus DD image mode| image:: /attachment/doc/rufus-dd-image-mode.png
|
||||
|
||||
|
||||
.. |ThinkPad T430 BIOS menu| image:: /attachment/doc/Thinkpad-t430-bios-main.jpg
|
||||
|
||||
|
||||
.. |UEFI menu| image:: /attachment/doc/uefi.jpeg
|
||||
|
||||
|
||||
.. |Boot screen| image:: /attachment/doc/boot-screen.png
|
||||
|
||||
|
||||
.. |welcome| image:: /attachment/doc/welcome-to-qubes-os-installation-screen.png
|
||||
|
||||
|
||||
.. |Unsupported hardware detected| image:: /attachment/doc/unsupported-hardware-detected.png
|
||||
|
||||
|
||||
.. |Installation summary not ready| image:: /attachment/doc/installation-summary-not-ready.png
|
||||
|
||||
|
||||
.. |Keyboard layout selection| image:: /attachment/doc/keyboard-layout-selection.png
|
||||
|
||||
|
||||
.. |Language support selection| image:: /attachment/doc/language-support-selection.png
|
||||
|
||||
|
||||
.. |Time and date| image:: /attachment/doc/time-and-date.png
|
||||
|
||||
|
||||
.. |Add-ons| image:: /attachment/doc/add-ons.png
|
||||
|
||||
|
||||
.. |Select storage device| image:: /attachment/doc/select-storage-device.png
|
||||
|
||||
|
||||
.. |Select storage passhprase| image:: /attachment/doc/select-storage-passphrase.png
|
||||
|
||||
|
||||
.. |Installation summary ready| image:: /attachment/doc/installation-summary-ready.png
|
||||
|
||||
|
||||
.. |Account name and password| image:: /attachment/doc/account-name-and-password.png
|
||||
|
||||
|
||||
.. |Grub boot menu| image:: /attachment/doc/grub-boot-menu.png
|
||||
|
||||
|
||||
.. |Unlock storage device screen| image:: /attachment/doc/unlock-storage-device-screen.png
|
||||
|
||||
|
||||
.. |Initial setup menu| image:: /attachment/doc/initial-setup-menu.png
|
||||
|
||||
|
||||
.. |Initial setup menu configuration| image:: /attachment/doc/initial-setup-menu-configuration.png
|
||||
|
||||
|
||||
.. |Login screen| image:: /attachment/doc/login-screen.png
|
||||
|
||||
|
||||
.. |Desktop menu| image:: /attachment/doc/desktop-menu.png
|
||||
|
||||
|
|
|
|||
|
|
@ -344,64 +344,23 @@ Getting help
|
|||
|
||||
|
||||
.. |Rufus menu| image:: /attachment/doc/rufus-menu.png
|
||||
|
||||
|
||||
.. |Rufus DD image mode| image:: /attachment/doc/rufus-dd-image-mode.png
|
||||
|
||||
|
||||
.. |ThinkPad T430 BIOS menu| image:: /attachment/doc/Thinkpad-t430-bios-main.jpg
|
||||
|
||||
|
||||
.. |UEFI menu| image:: /attachment/doc/uefi.jpeg
|
||||
|
||||
|
||||
.. |Boot screen| image:: /attachment/doc/boot-screen-4.2.png
|
||||
|
||||
|
||||
.. |Language selection window| image:: /attachment/doc/welcome-to-qubes-os-installation-screen-4.2.png
|
||||
|
||||
|
||||
.. |Unsupported hardware detected| image:: /attachment/doc/unsupported-hardware-detected.png
|
||||
|
||||
|
||||
.. |Installation summary screen awaiting input| image:: /attachment/doc/installation-summary-not-ready-4.2.png
|
||||
|
||||
|
||||
.. |Keyboard layout selection| image:: /attachment/doc/keyboard-layout-selection.png
|
||||
|
||||
|
||||
.. |Language support selection| image:: /attachment/doc/language-support-selection.png
|
||||
|
||||
|
||||
.. |Time and date| image:: /attachment/doc/time-and-date.png
|
||||
|
||||
|
||||
.. |Select storage device screen| image:: /attachment/doc/select-storage-device-4.2.png
|
||||
|
||||
|
||||
.. |Select storage passphrase| image:: /attachment/doc/select-storage-passphrase.png
|
||||
|
||||
|
||||
.. |Account name and password creation window.| image:: /attachment/doc/account-name-and-password-4.2.png
|
||||
|
||||
|
||||
.. |Windows showing installation complete and Reboot button.| image:: /attachment/doc/installation-complete-4.2.png
|
||||
|
||||
|
||||
.. |Grub boot menu| image:: /attachment/doc/grub-boot-menu.png
|
||||
|
||||
|
||||
.. |Screen to enter device decryption password| image:: /attachment/doc/unlock-storage-device-screen-4.2.png
|
||||
|
||||
|
||||
.. |Window with link for final configuration| image:: /attachment/doc/initial-setup-menu-4.2.png
|
||||
|
||||
|
||||
.. |Initial configuration menu| image:: /attachment/doc/initial-setup-menu-configuration-4.2.png
|
||||
|
||||
|
||||
.. |Login screen| image:: /attachment/doc/login-screen.png
|
||||
|
||||
|
||||
.. |Desktop menu| image:: /attachment/doc/desktop-menu.png
|
||||
|
||||
|
|
|
|||
|
|
@ -58,7 +58,6 @@ Qubes OS releases are supported for **six months** after each subsequent major o
|
|||
- In testing
|
||||
|
||||
|
||||
|
||||
Note on patch releases
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
|
@ -98,7 +97,6 @@ The table below shows the OS used for dom0 in each Qubes OS release.
|
|||
- Fedora 41
|
||||
|
||||
|
||||
|
||||
Note on dom0 and EOL
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
|
@ -129,7 +127,6 @@ It is the responsibility of each distribution to clearly notify its users in adv
|
|||
- 12, 13
|
||||
|
||||
|
||||
|
||||
Note on Debian support
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
|
|
|||
|
|
@ -111,7 +111,6 @@ Full list of options can be obtained with ``qubes-dist-upgrade --releasever=4.3
|
|||
use the normal method instead.
|
||||
|
||||
|
||||
|
||||
After installing the tool, before-reboot stages can be performed at once with:
|
||||
|
||||
.. code:: console
|
||||
|
|
|
|||
|
|
@ -42,7 +42,6 @@ Here’s a summary of the main component options available for this mid-tower de
|
|||
- Qubes OS 4.2 or Ubuntu 22.04 LTS
|
||||
|
||||
|
||||
|
||||
Of special note for Qubes users, the NitroPC Pro 2 features a combined PS/2 port that supports both a PS/2 keyboard and a PS/2 mouse simultaneously with a Y-cable (not included). This allows for full control of dom0 without the need for USB keyboard or mouse passthrough. Nitrokey also offers a special tamper-evident shipping method for an additional fee. With this option, the case screws will be individually sealed and photographed, and the NitroPC Pro 2 will be packed inside a sealed bag. Photographs of the seals will be sent to you by email, which you can use to determine whether the case was opened during transit.
|
||||
|
||||
The NitroPC Pro 2 also comes with a “Dasharo Entry Subscription,” which includes the following:
|
||||
|
|
|
|||
|
|
@ -36,7 +36,6 @@ The Qubes developers have tested and certified the following StarBook configurat
|
|||
- Qubes OS (pre-installation optional)
|
||||
|
||||
|
||||
|
||||
|image1|
|
||||
|
||||
The StarBook features a true matte 14-inch IPS display at 1920x1080 full HD resolution with 400cd/m² of brightness, 178° viewing angles, and a 180° hinge. The backlit keyboard is available in US English, UK English, French, German, Nordic, and Spanish layouts.
|
||||
|
|
|
|||
|
|
@ -34,7 +34,6 @@ Installing software from default repositories
|
|||
:alt: The Applications tab in Qube Settings
|
||||
|
||||
|
||||
|
||||
Installing software from other sources
|
||||
--------------------------------------
|
||||
|
||||
|
|
@ -88,7 +87,6 @@ This method assumes that you are trying to follow instructions to install some p
|
|||
:alt:
|
||||
|
||||
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
|
|
|
|||
|
|
@ -514,7 +514,6 @@ If a specific component is malfunctioning, you can increase its log verbosity as
|
|||
- Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: ``c:\move-profiles.log`` (it can’t use our common logger library so none of the log settings apply).
|
||||
|
||||
|
||||
|
||||
Updates
|
||||
-------
|
||||
|
||||
|
|
@ -526,13 +525,7 @@ When we publish new QWT version, it’s usually pushed to the ``current-testing`
|
|||
That command will download a new QWT .iso from the testing repository. It goes without saying that you should **backup your VMs** before installing anything from testing repos.
|
||||
|
||||
.. |windows-seamless-4.png| image:: /attachment/doc/windows-seamless-4.png
|
||||
|
||||
|
||||
.. |windows-seamless-1.png| image:: /attachment/doc/windows-seamless-1.png
|
||||
|
||||
|
||||
.. |windows-seamless-7.png| image:: /attachment/doc/windows-seamless-7.png
|
||||
|
||||
|
||||
.. |qtw-log-level.png| image:: /attachment/doc/qtw-log-level.png
|
||||
|
||||
|
|
|
|||
|
|
@ -543,7 +543,6 @@ If a specific component is malfunctioning, you can increase its log verbosity as
|
|||
- Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: ``C:\move-profiles.log`` (it can’t use our common logger library so none of the log settings apply).
|
||||
|
||||
|
||||
|
||||
If there are network-related issues, the qube doesn’t resolve DNS and has trouble accessing the Internet, this might be an issue with the PV Network Drivers.
|
||||
|
||||
In this case it’s recommended that the PV Network Drivers be unchecked during installation of Qubes Windows Tools as seen in the screenshot below.
|
||||
|
|
|
|||
|
|
@ -230,7 +230,4 @@ While this works well for standard applications, creating a menu entry for Windo
|
|||
.. note:: Applications installed under *wine* are installed in AppVMs, not in the template on which these AppVMs are based, as the file structure used by *wine* is stored under :file:`~/.wine`, which is part of the persistent data of the AppVM and not inherited from its template.
|
||||
|
||||
.. |image1| image:: /attachment/doc/r4.0-dom0-menu.png
|
||||
|
||||
|
||||
.. |image2| image:: /attachment/doc/r4.0-dom0-appmenu-select.png
|
||||
|
||||
|
|
|
|||
|
|
@ -28,10 +28,5 @@ Append ``qubes.skip_autostart`` to the end of this line (generally after the ``r
|
|||
Press ``Ctrl+X`` to boot with the edited GRUB entry. The boot will proceed as usual from here, except that no qube will be autostarted.
|
||||
|
||||
.. |grub1.png| image:: /attachment/doc/grub1.png
|
||||
|
||||
|
||||
.. |grub2.png| image:: /attachment/doc/grub2.png
|
||||
|
||||
|
||||
.. |grub3.png| image:: /attachment/doc/grub3.png
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue