diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | docs/installation/README.md | 13 | ||||
| -rw-r--r-- | docs/packaging/basics.md | 9 | ||||
| -rw-r--r-- | docs/packaging/building.md | 7 | ||||
| -rw-r--r-- | docs/packaging/custom/ruby.md | 2 | ||||
| -rw-r--r-- | docs/packaging/references.md | 5 | ||||
| -rw-r--r-- | docs/packaging/testing.md | 14 | ||||
| -rw-r--r-- | mkdocs.yml | 62 |
9 files changed, 113 insertions, 2 deletions
@@ -9,3 +9,4 @@ build-area puppet/modules keyring site +.cache @@ -22,6 +22,8 @@ web: web_deploy: @rsync -avz --delete --exclude=keyring site/ debian:/var/sites/debian/www/ +docs: web + publish: web web_deploy keyring: diff --git a/docs/installation/README.md b/docs/installation/README.md index e16162d..35243de 100644 --- a/docs/installation/README.md +++ b/docs/installation/README.md @@ -1,5 +1,18 @@ # Debian installation +## Basic + References, tips and notes about installing Debian-based systems: * [InstallingDebianOn - Debian Wiki](https://wiki.debian.org/InstallingDebianOn) + +## Minimal + +Minimal Debian installations: + +* [GitHub - debuerreotype/debuerreotype: reproducible, snapshot-based Debian rootfs builder](https://github.com/debuerreotype/debuerreotype) + +## Tuning + +* `dpkg`: + * [Save disk space by excluding useless files with dpkg](https://raphaelhertzog.com/2010/11/15/save-disk-space-by-excluding-useless-files-with-dpkg/) diff --git a/docs/packaging/basics.md b/docs/packaging/basics.md index 6eafa91..19fdb16 100644 --- a/docs/packaging/basics.md +++ b/docs/packaging/basics.md @@ -43,6 +43,15 @@ To remove: hydractl remove-dep package +Another way to get dependencies: + + aptitude search '!~i?reverse-depends("^package$")' -F "%p" | xargs aptitude install -y + +References: + +* [How to install only the dependencies of a package? - Ask Ubuntu](https://askubuntu.com/questions/74478/how-to-install-only-the-dependencies-of-a-package) +* [How to list/download the recursive dependencies of a debian package? - Stack Overflow](https://stackoverflow.com/questions/22008193/how-to-list-download-the-recursive-dependencies-of-a-debian-package) + ## Creating the `debian/` structure If the package wasn't debianized, proceed with diff --git a/docs/packaging/building.md b/docs/packaging/building.md index e29e742..dcfa8ad 100644 --- a/docs/packaging/building.md +++ b/docs/packaging/building.md @@ -2,8 +2,15 @@ ## Standard build +With `cowbuilder`: + DIST=bookworm sudo -E cowbuilder --build $package*.dsc +With `sbuild`: + +* [sbuild - Debian Package Tracker](https://tracker.debian.org/pkg/sbuild) +* [sbuild - Debian Wiki](https://wiki.debian.org/sbuild) + ## Signing To sign both the `.dsc` and the `.changes` files: diff --git a/docs/packaging/custom/ruby.md b/docs/packaging/custom/ruby.md index be79085..7db6eee 100644 --- a/docs/packaging/custom/ruby.md +++ b/docs/packaging/custom/ruby.md @@ -1,4 +1,4 @@ # Ruby packaging * See [this](https://wiki.debian.org/Teams/Ruby/Packaging). -* Example: [LEAP](/leap). +* Example: [LEAP](leap.md). diff --git a/docs/packaging/references.md b/docs/packaging/references.md index 0080468..33e5640 100644 --- a/docs/packaging/references.md +++ b/docs/packaging/references.md @@ -64,3 +64,8 @@ * [dh_sysuser(1) — dh-sysuser — Debian testing — Debian Manpages](https://manpages.debian.org/testing/dh-sysuser/dh_sysuser.1.en.html) * [Debian / dh-sysuser · GitLab](https://salsa.debian.org/debian/dh-sysuser) * [dh-sysuser. Yesterday I’ve discovered a dh-sysuser… | by George Shuklin | OpsOps | Medium](https://medium.com/opsops/dh-sysuser-6bd3e3d623dd) + +## Documentation + +* [dh\_sphinxdoc(1) — sphinx-common — Debian experimental — Debian Manpages](https://manpages.debian.org/unstable/sphinx-common/dh_sphinxdoc.1.en.html) +* [dh\_mkdocs(1) — mkdocs — Debian unstable — Debian Manpages](https://manpages.debian.org/unstable/mkdocs/dh_mkdocs.1.en.html) diff --git a/docs/packaging/testing.md b/docs/packaging/testing.md new file mode 100644 index 0000000..61b0625 --- /dev/null +++ b/docs/packaging/testing.md @@ -0,0 +1,14 @@ +# Testing + +## autopkgtest + +* [autopkgtest - Debian Package Tracker](https://tracker.debian.org/pkg/autopkgtest) +* [ContinuousIntegration/autopkgtest - Debian Wiki](https://wiki.debian.org/ContinuousIntegration/autopkgtest) +* [Autopkgtest - Defining tests for Debian packages](https://people.debian.org/~eriberto/README.package-tests.html) +* [autopkgtest](https://perl-team.pages.debian.net/autopkgtest.html) +* [autopkgtest — Debian LTS team documentation](https://lts-team.pages.debian.net/wiki/TestSuites/autopkgtest.html) + * [autodep8(1) — autodep8 — Debian unstable — Debian Manpages](https://manpages.debian.org/unstable/autodep8/autodep8.1.en.html) + +## piuparts + +* [piuparts(1) — piuparts 0.98 documentation](https://piuparts.debian.org/doc/html/piuparts/piuparts.1.html#cmdoption-piuparts-i) @@ -17,7 +17,66 @@ theme: # # This option was superseded by the privacy plugin: # https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin - font: false + #font: false + +# Plugins +# https://www.mkdocs.org/dev-guide/plugins/ +plugins: + # Search + # See https://www.mkdocs.org/user-guide/configuration/#search + # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/ + search: {} + + # Note that this might not be available in the mkdocs-material package from + # Debian bookworm (as of 2024-08-23) + privacy: {} + +# Markdown extensions +# See https://www.mkdocs.org/user-guide/configuration/#markdown_extensions +# https://squidfunk.github.io/mkdocs-material/setup/extensions/ +markdown_extensions: + # Footnotes + # https://squidfunk.github.io/mkdocs-material/reference/footnotes/ + footnotes: {} + + # Tasklist handling + # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist + pymdownx.tasklist: + custom_checkbox: true + + # SuperFences + # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences + pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + + # Table of Contents configuration + # See https://www.mkdocs.org/user-guide/configuration/#markdown_extensions + # https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages + toc: + permalink: true + + # Attribute Lists + # Needed by proper image handling + # https://squidfunk.github.io/mkdocs-material/reference/images/ + # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists + attr_list: {} + + # Markdown in HTML + # Needed by proper image handling + # https://squidfunk.github.io/mkdocs-material/reference/images/ + # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html + md_in_html: {} + +# Copyright notice +copyright: Copyleft © 2024 Fluxo Group. See LICENSE for details. + +# Extra template parameters +# https://www.mkdocs.org/user-guide/configuration/#extra +extra: + generator: false # Navigation # https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation @@ -34,6 +93,7 @@ nav: - packaging/env.md - packaging/checking.md - packaging/building.md + - packaging/testing.md - packaging/repositories.md - packaging/cross.md - packaging/custom/python.md |