Editing the qubes doc with side-by-side preview revisions

Go back to topic: Editing the qubes doc with side-by-side preview

  1. v6 anchor; v6 full version
  2. v5 anchor; v5 full version
  3. v4 anchor; v4 full version
  4. v3 anchor; v3 full version
  5. v2 anchor; v2 full version

Revision #6

Edited on
2025-09-12
Edited by user
saces
little writeup 'bout my setup for editing the new read-the-docs version of the qubes doc ([forum-doc-announcement](https://forum.qubes-os.org/t/qubes-users-the-qubes-documentation-is-migrating-to-read-the-docs/35033)) little writeup 'bout my setup for editing the new read-the-docs version of the qubes doc ([forum-doc-announcement](https://forum.qubes-os.org/t/qubes-users-the-qubes-documentation-has-successfully-migrated-to-read-the-docs/36070))
In an ideal world you would be done now, but… The patches required to have the preview working are in my private fork: [https://codeberg.org/saces/qubes-doc](https://codeberg.org/saces/qubes-doc) Use it in a bare directory ``` mkdir docium cd docium git clone https://codeberg.org/saces/qubes-doc . codium . ``` or add it to your existing project ``` git remote add docium https://codeberg.org/saces/qubes-doc.git git fetch docium docium … ``` This repository is push -f'ed each time I sync with upstream, so my changes are always on top. Done. Now open the rst files in codium…

Revision #5

Edited on
2025-09-12
Edited by user
saces

Revision #4

Edited on
2025-09-01
Edited by user
saces
![excalidraw|689x454](upload://edbCIjEDBrOBBksVj0JSsfnj1n3.png) ![excalidraw|689x454](upload://edbCIjEDBrOBBksVj0JSsfnj1n3.png)
They are written for the [AppVM](https://codeberg.org/saces/qmbadmin) I'm working from (remember the first rule of the qubes club: `You shall not work in Dom0!`) and everything is either default or hardcoded, so you **_must_** review and adjust them before running them. They are written initially for the [AppVM](https://codeberg.org/saces/qmbadmin) I'm working from (remember the first rule of the qubes club: `You shall not work in Dom0!`), they should work in such an environment and from Dom0.
No parameters yet, so it creates a template `qmb-docium-template` based upon fedora-42-xfce.
setup-template.sh setup-template.sh TEMPLATE NEW_TEMPLATE
Next TODO: make it work in Dom0 Example: `setup-template.sh fedora-42-xfce qmb-docium-template`
No parameters yet, so it creates a purple appvm `qmb-docium` with template `qmb-docium-template`.
setup-appvm.sh setup-appvm.sh TEMPLATE APPVM LABEL
Next TODO: make it work in Dom0 Example: `setup-appvm.sh qmb-docium-template qmb-docium purple`
I prefer matrix: [#qubism:c-base.org](https://matrix.to/#/#qubism:c-base.org), forum will work too. If you created patches and don't have a codeberg.org account, just publish them and send me the url so I can pick them up or send patch or bundle files via matrix for incorperating them. Many thanks!.I prefer matrix: [#qubism:c-base.org](https://matrix.to/#/#qubism:c-base.org), forum and other channels will work too. If you created patches and don't have a codeberg.org account, just publish them and send me the url so I can pick them up or send patch or bundle files via matrix for incorporating them. Many thanks!.

Revision #3

Edited on
2025-09-01
Edited by user
saces

Revision #2

Edited on
2025-08-31
Edited by user
saces
little writeup 'bout my qubes doc editing setup. little writeup 'bout my setup for editing the new read-the-docs version of the qubes doc ([forum-doc-announcement](https://forum.qubes-os.org/t/qubes-users-the-qubes-documentation-is-migrating-to-read-the-docs/35033))