Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparation for rst conversion #1418

Open
wants to merge 52 commits into
base: main
Choose a base branch
from
Open

Preparation for rst conversion #1418

wants to merge 52 commits into from

Conversation

maiska
Copy link

@maiska maiska commented Aug 11, 2024

Fixed some issues that were fixable in mardown and listed in #1367.

This pull request should ease up and eliminate a lot of small annonying errors when converting

Copy link
Member

@marmarek marmarek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've briefly looked at some of the changes here, and some look problematic. See specific comments below.

> policy/qubesos/code-signing — No signature found
2. If the commit is signed, the key is downloaded from a GPG key server.
3. If the commit is signed, the key is downloaded from a GPG key server.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previous point is "1", so why "3" here?

@@ -64,7 +66,7 @@ any GNU/Linux system with the following procedure.
supported message digest algorithms can be found with `openssl
list-message-digest-algorithms`.

4. Read the `backup-header`. You'll need some of this information later. The
5. Read the `backup-header`. You'll need some of this information later. The
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previous point is "3", so why "5" here (and renumbering others below)?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was not my intention. I can correct that. Thanks for pointing out!

Shut down your template. Then, either reboot your USB VM (so changes inside
the template take effect in your USB app qube) or install the packages inside
your USB VM as well if you would like to avoid rebooting it.

2. Install [qubes-app-yubikey](https://github.com/QubesOS/qubes-app-yubikey) in
1. Install [qubes-app-yubikey](https://github.com/QubesOS/qubes-app-yubikey) in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is supposed to be continuation of the list, see https://www.qubes-os.org/doc/mfa/

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was not my intention. I can correct that. Thanks for pointing out!

@@ -173,7 +173,7 @@ Installing the Qubes Windows Tools on Windows 7, 8.1, 10 and 11 both as a Standa

If Windows is used in a TemplateVM / AppVM combination, this registry fix has to be applied to the TemplateVM, as the `HKLM` registry key belongs to the template-based part of the registry.

10. Lastly to enable file copy operations to a Windows VM, the `default_user` property of this VM should be set to the `<username>` that you use to login to the Windows VM. This can be done via the following command on a `dom0` terminal: *(where `<VMname>` is the name of your Windows VM)*
10. Lastly to enable file copy operations to a Windows VM, the `default_user` property of this VM should be set to the `<username>` that you use to login to the Windows VM. This can be done via the following command on a `dom0` terminal: *(where <VMname> is the name of your Windows VM)*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this correct? I think without quoting this will be interpreted as (invalid) html tag... (but I haven't checked)
Similar comments below

Copy link
Author

@maiska maiska Aug 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is because rst cannot embed emphasis inside italics and vice versa etc, as far as I read the documentation. I can leave it unchanged but it will be broken after conversion. You are right about the html tag.
Curiously enough when I rendered sphinx locally there was not a problem.
Here with the original markdown: https://current-qubes-docrtd.readthedocs.io/en/rtd-deploy-test/user/templates/windows/qubes-windows-tools-4-1.html vs the fix from above: https://current-qubes-docrtd.readthedocs.io/en/rtd-deploy-pr/user/templates/windows/qubes-windows-tools-4-1.html. Search for 'command in dom0'
I will revert it and it can be fixed after conversion
somehow it seems broken. i ran the conversion again on the PR status and it is deploying now.
I suppose i deployed another state of a branch.

@@ -277,7 +277,7 @@ Now you should have a menu `Disposable: <VMname>` containing the applications th

For further information on usage of disposables, see [How to use disposables](/doc/how-to-use-disposables/).

**Caution:** *If a Windows-based disposable is used from another qube via the `Open/Edit in DisposableVM` command, this disposable may not close automatically, due to the command prompt window still running in this dispvm. In this case, the disposable has to be shut down manually.*
**Caution:** *If a Windows-based disposable is used from another qube via the Open/Edit in DisposableVM command, this disposable may not close automatically, due to the command prompt window still running in this dispvm. In this case, the disposable has to be shut down manually.*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think some quoting should remain here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well it is broken in both of the deployments. So, revert it is

```
```
nouveau.modeset=0 rd.driver.blacklist=nouveau video=vesa:off
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This text is supposed to be for point "3" above, not outside of the list.

```
```
noexitboot=1 modprobe.blacklist=nouveau rd.driver.blacklist=nouveau --- intitrd.img
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And similar here.

@@ -277,7 +277,7 @@ Now you should have a menu `Disposable: <VMname>` containing the applications th

For further information on usage of disposables, see [How to use disposables](/doc/how-to-use-disposables/).

**Caution:** *If a Windows-based disposable is used from another qube via the Open/Edit in DisposableVM command, this disposable may not close automatically, due to the command prompt window still running in this dispvm. In this case, the disposable has to be shut down manually.*
**Caution:** *If a Windows-based disposable is used from another qube via the* `Open/Edit in DisposableVM` *command, this disposable may not close automatically, due to the command prompt window still running in this dispvm. In this case, the disposable has to be shut down manually.*
Copy link
Author

@maiska maiska Aug 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I just splitted the sentence in parts that need an emphasis or highlight so that i can go around the rst problem i mentioned earlier.
for example now it looks like : https://current-qubes-docrtd.readthedocs.io/en/rtd-deploy-pr/user/templates/windows/qubes-windows-tools-4-1.html
@marmarek FYI
also just fixed an identation error when visiting a bold text with docutils converter script. should be deployed in a minute

@maiska maiska requested a review from marmarek August 14, 2024 07:02
Copy link
Member

@marmarek marmarek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Approved as of df88acabc3c1aa6a4ead30c8af03e5aac1351d9b
-----BEGIN PGP SIGNATURE-----

iQIzBAEBCAAdFiEEnYWYU8Ll1fIX9iss8yiUvpaEk4oFAma80hoACgkQ8yiUvpaE
k4qZfw/9Fvovv9pbrXm8W3p6pNtiS/EHfb3Tco8ulLAO6aEbVPrWJ/XAybjgubPl
kPVPrlmSH31+1Hua7dRmMCnIK4gfKXd1KqSqbiVLl6qUIiE18IHoyeUzOWNtHx6b
mSuqNZmM4WkyRTJ94VjpBLy7HKPRR6cZUZKYX8D3P8axlMG+AUAsEkAPVBqk89BE
dEUlEjuKbXpJmw2tVL5CT/MmIc8y96lUSku2okfWBhqX8OIwh1H3Fume55kDSSAc
WpgS8ra1hAbASL+OQdIE4bD8MHy6Mz9apa9Q/g17yecQ6GS5ha8iUiT6ql7fM+Ik
m8xrtFv08QN+ZCx/qKxGvqb6kYCOkKXSjIy5vu8dyzeYm46fSFoubmCWw4RJcAoq
wnWVDpBV/BP53F+NF0l8Uerr9CI72eLGJY6hUKtUsqf0zh6x7pXchQs081LRI3FI
9QxJUsVKn62f7eFdwmhbbwMqSfXNBI1jblZgKzcG+cGW9+P49UZ5Vy3y+z+QvJZP
Jb+rCTG0Ewy+ehPvlSRaP2WhrIRVc+HXzCnOgAutFUUa8r3zNXM2KlBXhl0p+PuE
XnH3bZCcyBBwpBofWK/+32NQeQz6fB9SHlq6z2xiaN5WZO3fFj4IiY/sbaH/DLag
S/yBfNNCe6yYDgz91cuNK3q5dACf+TmJLOMhiv++rtjRhzTPcT0=
=w7DJ
-----END PGP SIGNATURE-----

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants