Commit graph

75 commits

Author SHA1 Message Date
qubedmaiska
1be6e5f9b9
fixed linter warnings 2025-09-09 12:05:31 -04:00
qubedmaiska
6218ea2dce
Merge remote-tracking branch 'parulin/warning-fix' into rst 2025-09-06 05:42:29 -04:00
parulin
11b2626fa2
Merge branch 'rst' into paragraphs-workaround-2 2025-08-26 05:50:29 +00:00
parulin
b02eba099e
Fix of tables options and emphasis 2025-08-26 01:43:59 -04:00
parulin
06c6503932
Fixing various warnings from sphinx-build
* missing theme options in conf.py
* orphaned pages are tagged as such
* a markup mistake
* duplicate labels
* a code-block marked as python code
2025-08-18 16:52:34 -04:00
parulin
dbbed6af86
Restoring Fedora and Debian instructions
Fixing a previous mistake.
2025-08-18 03:10:23 -04:00
qubedmaiska
def5eec5c9
Extract session comments into instructions 2025-08-16 14:23:13 -04:00
qubedmaiska
43493b38e6
Add prompts to all code blocks with bash session 2025-08-16 14:23:09 -04:00
parulin
483fce4c63
Minor cleaning of code highlighting
* Most of text blocks are in fact output blocks
* On qubes-iso-building.rst, try to get something correct for console
  lines starting with a comment
* Fixing a wrong :menuselection: item.

Statistics:

    685 console
     79 text
     44 bash
     35 output
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html
2025-08-16 14:23:02 -04:00
parulin
0ff244e167
Correct code-block lexers
Changing `bash` lexer to `console` because it is appropriate most of
the time. Then after a manual review, some lexer have been changed.

I used `text` each time I was unsure, and for prompt outputs.

The page `/developer/building/qubes-iso-building.rst` still need to be
reviewed (look for lines starting with `$ #`).

I'm not sure about the Windows pages, should we use
[doscon](https://pygments.org/docs/lexers/#pygments.lexers.shell.MSDOSSessionLexer)
or `powershell`?

Is there an appropriate lexer for `guid.conf` content?

**Statistics - Before**
    870 bash
      9 python
      9 c
      2 yaml

**Statistics - After**
    684 console
    111 text
     44 bash
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html

This suggests that the default lexer should be `console`.
2025-08-16 14:23:00 -04:00
parulin
fa7a62b529
Use console lexer instead of bash with a prompt 2025-08-16 14:22:55 -04:00
Tobias Killer
cad541c3af
Merge branch 'rst' into toki_fix_findings 2025-08-16 20:05:30 +02:00
qubedmaiska
e3e699fa5e
Extract session comments into instructions 2025-08-16 09:31:12 -04:00
qubedmaiska
2d2bcb06a6
Add prompts to all code blocks with bash session 2025-08-15 16:49:01 -04:00
parulin
8489fcc4fa
Migration: fix indented lists and raw html tables
All raw directives have been removed or replaced by reStructuredText
list-tables.
2025-08-09 17:58:19 -04:00
Tobias Killer
0cfd755295 Fix formattings and other issues
See issue 8180.
2025-08-09 09:50:36 +02:00
parulin
6f4370f793
Minor cleaning of code highlighting
* Most of text blocks are in fact output blocks
* On qubes-iso-building.rst, try to get something correct for console
  lines starting with a comment
* Fixing a wrong :menuselection: item.

Statistics:

    685 console
     79 text
     44 bash
     35 output
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html
2025-08-08 16:55:35 -04:00
parulin
4212c5eda8
Correct code-block lexers
Changing `bash` lexer to `console` because it is appropriate most of
the time. Then after a manual review, some lexer have been changed.

I used `text` each time I was unsure, and for prompt outputs.

The page `/developer/building/qubes-iso-building.rst` still need to be
reviewed (look for lines starting with `$ #`).

I'm not sure about the Windows pages, should we use
[doscon](https://pygments.org/docs/lexers/#pygments.lexers.shell.MSDOSSessionLexer)
or `powershell`?

Is there an appropriate lexer for `guid.conf` content?

**Statistics - Before**
    870 bash
      9 python
      9 c
      2 yaml

**Statistics - After**
    684 console
    111 text
     44 bash
     16 yaml
      9 systemd
      9 c
      8 python
      4 ini
      4 doscon
      2 markdown
      2 desktop
      1 xorg.conf
      1 xml+jinja
      1 xml
      1 kconfig
      1 html

This suggests that the default lexer should be `console`.
2025-08-08 16:55:35 -04:00
parulin
a252dc4338
Use console lexer instead of bash with a prompt 2025-08-08 16:55:34 -04:00
Marek Marczykowski-Górecki
f058f77394
manual fixes
Manual fixes after the conversion tool. Mostly based on sphinx warnings.
2025-08-06 02:20:01 +02:00
Marek Marczykowski-Górecki
918eaa479d
Convert to RST
This is done using tools at
https://github.com/maiska/qubes-translation-utilz, commit
4c8e2a7f559fd37e29b51769ed1ab1c6cf92e00d.
2025-08-06 02:19:56 +02:00
Marek Marczykowski-Górecki
e14921b8a3
Rename all md files to rst
This is plain rename without changing content, to help git track files
history.
Do not touch files that are going to be removed during conversion.

Thanks @parulin for the idea!
2025-08-06 02:16:04 +02:00
qubedmaiska
284e6d41f4
format fixes 2025-05-14 19:10:54 -04:00
unman
63ad8ab1c1
Minor changes to description of qubes-builder-v2 2025-04-13 12:57:18 +00:00
unman
81e4abc416
Minor changes to workflow.md using Builder v2 2025-04-13 12:55:19 +00:00
unman
7b8f4e0740
Add introduction for Builder v2
Merge branch 'pr-1409'
2025-04-13 12:47:00 +00:00
Marta Marczykowska-Górecka
06e37e444b
Add intro for Builder v2 2025-03-22 22:18:04 +01:00
unman
f7008ae73d
qubes-builderv1 still support 4.2 builds - make clear in another notification 2024-07-10 13:40:07 +00:00
deeplow
112e9996eb
qubes-builderv1 still support 4.2 builds 2024-06-12 05:19:49 -04:00
Dmitry V. Levin
7a15cd1a16
Fix a few typos 2024-04-26 08:00:00 +00:00
unman
65444ee38f
Fix formatting in warning notes 2024-03-12 17:22:50 +00:00
deeplow
1890f09056
Mention existence of Qubes Builder V2
Qubes Builder V1 is still supported at least until Qubes 4.1
reaches EOL. However the docs don't mention at all the existance of
version 2 of the builder. The ideal solution would be to
document builder v2, while that doesn't happen, at least having a
warning is better than nothing.
2024-03-03 10:23:01 +00:00
Marek Marczykowski-Górecki
173054362c
Fix headings in 2 developer docs pages
Use heading levels consistently, especially:
 - do not use title in the middle of the page - there is just one page
   title, at the top, added automatically
 - do not skip levels (if there is ###, put ## before)
2023-10-29 17:16:35 +01:00
Andrew David Wong
b8695e26bc
Merge branch 'pr-1313' 2023-05-01 01:08:09 -07:00
journoSEC
e4e0b294db
Update qubes-iso-building.md
Changed Fedora template references
2023-05-01 07:49:41 +00:00
journoSEC
a16a03c6f4
Update qubes-iso-building.md
Changed Fedora references for updated templates
2023-05-01 07:49:08 +00:00
Marek Marczykowski-Górecki
6a6321ff3f
qubes-builder: add dnf-plugins-core dependency
It's necessary for 'dnf builddep' command that qubes-builder uses.
2023-01-24 15:38:24 +01:00
Neowutran
f6ed045931
builder: set selinux to permissive 2022-11-05 21:10:37 +01:00
Neowutran
2287b99513
builder: add note about default selinux policy blocking the builder on fedora host 2022-11-03 22:53:29 +01:00
Gottale
f841a7b9e5
Minor update to qubes-iso-building.md
Change reference from 4.0 > 4.1, adjust template examples to match current releases, updated expired GPG key reference.
2022-10-31 19:57:18 +00:00
Marek Marczykowski-Górecki
2171e182ee
Use https to clone qubes-builder
Builder config points at https for a long time, but the documentation
still used git:// protocol. Update that, especially as github
discontinued support for it.
2022-03-16 13:38:12 +01:00
Andrew David Wong
54525b2e09
Update links; fix typo 2021-07-20 03:27:51 -07:00
Andrew David Wong
ca0ccab949
Update titles and links 2021-07-10 14:25:29 -07:00
Andrew David Wong
a18174dc5e
Fix capitalization; update terms (QubesOS/qubes-issues#6769)
Thank you to @unman for the initial sentence case pass.
2021-07-09 05:10:44 -07:00
unman
d0bc9e70a2
Sentence case for titles 2021-07-09 01:06:41 +00:00
Yann Dirson
04c8ea50b0 qubes-builder: fix typo in rpmmacros filename, improve its markup 2021-06-26 17:34:47 -04:00
Marek Marczykowski-Górecki
4017d11de3
Run script to add 'ref' parameters 2021-06-24 18:19:05 +02:00
Marek Marczykowski-Górecki
3806ecf338
Remove extra newlines at the beginning/end of files
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.
2021-06-24 16:07:23 +02:00
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
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