Commit Graph

46 Commits

Author SHA1 Message Date
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
Andrew David Wong 4ff7430960
Remove redundant h1 titles using `#` syntax
https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-16 00:29:28 -07:00
Andrew David Wong a4cbb51092
Remove vestigial '====' heading syntax
https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:53:27 -07:00
Andrew David Wong f822b70435
Remove redundant titles
First pass for all titles still using the old '=====' syntax

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:48:48 -07:00
Andrew David Wong 0c95b3ae4d
Revert "Remove instances of `title:` from YAML headers"
This reverts commit 24e6a8a616.

https://github.com/QubesOS/qubes-issues/issues/6701#issuecomment-862060759
2021-06-15 23:19:45 -07:00
Andrew David Wong c815e4c54c
Remove all instances of `permalink:` in YAML frontmatter
Converts existing permalink paths into redirect_from entries.

QubesOS/qubes-issues#6701
2021-06-15 22:33:51 -07:00
Andrew David Wong 24e6a8a616
Remove instances of `title:` from YAML headers
QubesOS/qubes-issues#6701
2021-06-15 22:16:59 -07:00
Tobias Killer 190b740e32
Resolve open issues mentioned on Transifex 2021-04-17 10:31:11 +02:00
Tobias Killer 617330d026
Resolve open issues mentioned on Transifex 2021-04-16 19:45:56 +02:00
Tobias Killer b6cb04c297
Refactor links in order to obey the new convention rule 2021-04-11 00:09:05 +02:00
Marek Marczykowski-Górecki 752f1d4ddc
Fix over indented code blocks 2021-03-28 20:58:39 +02:00
Maya 820af56761
Add lang + ref tags to frontmatter
Those are fields used by the language switcher to correlate pages across
different languages, even if they have different names/paths/titles.
They are generated with the prepare_for_translation.py script.
2021-03-14 16:18:11 +01:00
Maya 8f8a8e50ea
Normalize frontmatter
- sort keys
- remove permalink from redirects
2021-03-14 16:18:10 +01:00
Maya 67a92614aa
Markdown formatting fixes
- mark all code blocks with ```
- unify empty lines between sections
- adjust list syntax (no space before dash)
- adjust headers to use Atx-style syntax
- remove trailing spaces
2021-03-14 16:18:10 +01:00
Andrew David Wong 30e7112f4a
Convert absolute to relative links
Absolute links break automatic onion redirection:
https://groups.google.com/g/qubes-users/c/NJdzP27wvmM/
2020-12-07 17:04:29 -08:00
Andrew David Wong 8d6fc28c1a
Merge branch 'patch-3' of https://github.com/dmoerner/qubes-doc into dmoerner-patch-3 2020-10-09 20:39:07 -05:00
Andrew David Wong 9169458de8
Link to build security post 2020-10-09 19:29:43 -05:00
Daniel Moerner ded05b0260
Update qubes-builder.md
PyYAML has been renamed to python3-pyyaml in newer versions of Fedora.
2020-10-03 21:39:32 -04:00
Frédéric Pierret (fepitre) 7a0c466b27
Update qubes-iso-building 2020-09-22 12:36:53 +02:00
unman 4783f2a989
Qubes-builder - update template versions 2020-02-23 00:36:50 +00:00
Andrew David Wong 939995eda9
Merge branch 'patch-5' of https://github.com/mfp20/qubes-doc into mfp20-patch-5 2020-01-19 16:34:39 -06:00
mfp20 3bbf7b91ce
Adds "Notes" chapter
Can be used to include misc notes.
2020-01-16 19:17:04 +01:00
mfp20 272a24843f
Create "Further information" chapter.
And move the lines from the top to this chapter.
In order to give a hook for advanced use and have it in the left side contents menu for easy access.
2020-01-16 18:53:12 +01:00
Marek Marczykowski-Górecki 12ecfe47f5
Update qubes-builder dependencies: python2-sh -> python3-sh 2019-11-27 04:06:00 +01:00
unman f480010f8b
Clarify inability to use QUBES_REPO for Ubuntu.
General tidy up.
2019-07-01 14:28:29 +00:00
Andrew David Wong d31c786942
Reorganize files to account for new "External" section
QubesOS/qubes-issues#4693
2019-05-26 19:32:45 -05:00