Skip to content

Commit

Permalink
Preserve old docs location
Browse files Browse the repository at this point in the history
  • Loading branch information
daudix committed Oct 10, 2024
1 parent b831850 commit 5d23abd
Show file tree
Hide file tree
Showing 95 changed files with 41 additions and 40 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tags
*.vim
TODO.txt
docs/public/
site/public/
4 changes: 2 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "docs/themes/duckquill"]
path = docs/themes/duckquill
[submodule "site/themes/duckquill"]
path = site/themes/duckquill
url = https://codeberg.org/daudix/duckquill.git
4 changes: 2 additions & 2 deletions docs/README.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ graphical apps (X11/Wayland), and audio.
## Documentation

Documentation for the [latest release](https://github.com/89luca89/distrobox/releases/latest) is available
over at [distrobox.it](https://distrobox.it). Documentation in the `docs/content/` directory on GitHub strictly
over at [distrobox.it](https://distrobox.it). Documentation in the `docs/` directory on GitHub strictly
refers to the code in the main branch and is not optimized for being viewed without building it as the website.

To build the website:

1. Clone this repository recursively: `git clone --recursive https://github.com/89luca89/distrobox.git`
2. Install [Zola](https://www.getzola.org) >= v0.19.2.
3. Enter the `docs` directory.
3. Enter the `site` directory.
4. Run `zola serve`
6 changes: 3 additions & 3 deletions distrobox-create
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ Options:
--pre-init-hooks: additional commands to execute at the start of container initialization
--init/-I: use init system (like systemd) inside the container.
this will make host's processes not visible from within the container. (assumes --unshare-process)
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/content/useful_tips.md#using-init-system-inside-a-distrobox
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/useful_tips.md#using-init-system-inside-a-distrobox
--nvidia: try to integrate host's nVidia drivers in the guest
--unshare-devsys: do not share host devices and sysfs dirs from host
--unshare-groups: do not forward user's additional groups into the container
Expand All @@ -235,7 +235,7 @@ Compatibility:
man distrobox-compatibility
or run
distrobox create --compatibility
or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md
or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/compatibility.md
EOF
}

Expand Down Expand Up @@ -537,7 +537,7 @@ if ! command -v "${container_manager}" > /dev/null && [ "${dryrun}" -eq 0 ]; the
printf >&2 "You can follow the documentation on:\n"
printf >&2 "\tman distrobox-compatibility\n"
printf >&2 "or:\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
exit 127
fi
# add verbose if -v is specified
Expand Down
2 changes: 1 addition & 1 deletion distrobox-enter
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ if ! command -v "${container_manager}" > /dev/null && [ "${dryrun}" -eq 0 ]; the
printf >&2 "You can follow the documentation on:\n"
printf >&2 "\tman distrobox-compatibility\n"
printf >&2 "or:\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
exit 127
fi

Expand Down
38 changes: 19 additions & 19 deletions distrobox-generate-entry
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ if ! command -v "${container_manager}" > /dev/null; then
printf >&2 "You can follow the documentation on:\n"
printf >&2 "\tman distrobox-compatibility\n"
printf >&2 "or:\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
exit 127
fi

Expand Down Expand Up @@ -300,24 +300,24 @@ if [ "${icon}" = "auto" ]; then
# This is a NON comprehensive list of logos of the most popular distributions. If you find logos for
# other supported distros, add it here.
DISTRO_ICON_MAP="
alma:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/alma-distrobox.png
alpine:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/alpine-distrobox.png
arch:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/arch-distrobox.png
centos:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/centos-distrobox.png
clear--os:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/clear-distrobox.png
debian:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/debian-distrobox.png
deepin:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/deepin-distrobox.png
fedora:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/fedora-distrobox.png
gentoo:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/gentoo-distrobox.png
kali:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/kali-distrobox.png
kdeneon:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/kdeneon-distrobox.png
opensuse-leap:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/opensuse-distrobox.png
opensuse-tumbleweed:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/opensuse-distrobox.png
rhel:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/redhat-distrobox.png
rocky:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/rocky-distrobox.png
ubuntu:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/ubuntu-distrobox.png
vanilla:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/vanilla-distrobox.png
void:https://raw.githubusercontent.com/89luca89/distrobox/main/docs/static/assets/distros/void-distrobox.png
alma:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/alma-distrobox.png
alpine:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/alpine-distrobox.png
arch:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/arch-distrobox.png
centos:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/centos-distrobox.png
clear--os:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/clear-distrobox.png
debian:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/debian-distrobox.png
deepin:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/deepin-distrobox.png
fedora:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/fedora-distrobox.png
gentoo:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/gentoo-distrobox.png
kali:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/kali-distrobox.png
kdeneon:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/kdeneon-distrobox.png
opensuse-leap:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/opensuse-distrobox.png
opensuse-tumbleweed:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/opensuse-distrobox.png
rhel:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/redhat-distrobox.png
rocky:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/rocky-distrobox.png
ubuntu:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/ubuntu-distrobox.png
vanilla:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/vanilla-distrobox.png
void:https://raw.githubusercontent.com/89luca89/distrobox/main/site/static/assets/distros/void-distrobox.png
"
# Try to detect container's distribution by using /etc/os-release
${container_manager_cp_command} "${container_name}":/etc/os-release /tmp/"${container_name}".os-release
Expand Down
2 changes: 1 addition & 1 deletion distrobox-list
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ if ! command -v "${container_manager}" > /dev/null; then
printf >&2 "You can follow the documentation on:\n"
printf >&2 "\tman distrobox-compatibility\n"
printf >&2 "or:\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
exit 127
fi
# add verbose if -v is specified
Expand Down
2 changes: 1 addition & 1 deletion distrobox-rm
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ if ! command -v "${container_manager}" > /dev/null; then
printf >&2 "You can follow the documentation on:\n"
printf >&2 "\tman distrobox-compatibility\n"
printf >&2 "or:\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
exit 127
fi

Expand Down
2 changes: 1 addition & 1 deletion distrobox-stop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ if ! command -v "${container_manager}" > /dev/null; then
printf >&2 "You can follow the documentation on:\n"
printf >&2 "\tman distrobox-compatibility\n"
printf >&2 "or:\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
exit 127
fi
# add verbose if -v is specified
Expand Down
2 changes: 1 addition & 1 deletion distrobox-upgrade
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ if ! command -v "${container_manager}" > /dev/null; then
printf >&2 "You can follow the documentation on:\n"
printf >&2 "\tman distrobox-compatibility\n"
printf >&2 "or:\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md\n"
printf >&2 "\thttps://github.com/89luca89/distrobox/blob/main/docs/compatibility.md\n"
exit 127
fi

Expand Down
1 change: 1 addition & 0 deletions docs
4 changes: 2 additions & 2 deletions extras/install-podman
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
echo "This script is deprecated and unsupported"
echo "head over to:"
echo ""
echo "https://github.com/89luca89/distrobox/blob/main/docs/content/posts/install_podman_static.md"
echo "https://github.com/89luca89/distrobox/blob/main/docs/posts/install_podman_static.md"
echo "or"
echo "https://github.com/89luca89/distrobox/blob/main/docs/content/posts/install_lilipod_static.md"
echo "https://github.com/89luca89/distrobox/blob/main/docs/posts/install_lilipod_static.md"
echo ""
echo "for updated instructions on how to install podman-launcher"

Expand Down
4 changes: 2 additions & 2 deletions man/man1/distrobox-create.1
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ usb devices and graphical apps (X11/Wayland), and audio.
--pre-init-hooks: additional commands to execute at the start of container initialization
--init/-I: use init system (like systemd) inside the container.
this will make host\[aq]s processes not visible from within the container. (assumes --unshare-process)
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/content/useful_tips.md#using-init-system-inside-a-distrobox
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/useful_tips.md#using-init-system-inside-a-distrobox
--nvidia: try to integrate host\[aq]s nVidia drivers in the guest
--unshare-devsys: do not share host devices and sysfs dirs from host
--unshare-groups: do not forward user\[aq]s additional groups into the container
Expand All @@ -81,7 +81,7 @@ usb devices and graphical apps (X11/Wayland), and audio.
for a list of compatible images and container managers, please consult the man page:
man distrobox
man distrobox-compatibility
or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md#containers-distros
or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/compatibility.md#containers-distros
\f[R]
.fi
.SH EXAMPLES
Expand Down
4 changes: 2 additions & 2 deletions man/man1/distrobox.1
Original file line number Diff line number Diff line change
Expand Up @@ -917,7 +917,7 @@ usb devices and graphical apps (X11/Wayland), and audio.
--pre-init-hooks: additional commands to execute at the start of container initialization
--init/-I: use init system (like systemd) inside the container.
this will make host\[aq]s processes not visible from within the container. (assumes --unshare-process)
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/content/useful_tips.md#using-init-system-inside-a-distrobox
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/useful_tips.md#using-init-system-inside-a-distrobox
--nvidia: try to integrate host\[aq]s nVidia drivers in the guest
--unshare-devsys: do not share host devices and sysfs dirs from host
--unshare-groups: do not forward user\[aq]s additional groups into the container
Expand All @@ -942,7 +942,7 @@ usb devices and graphical apps (X11/Wayland), and audio.
for a list of compatible images and container managers, please consult the man page:
man distrobox
man distrobox-compatibility
or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md#containers-distros
or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/compatibility.md#containers-distros
\f[R]
.fi
.SH EXAMPLES
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ graphical apps (X11/Wayland), and audio.
--pre-init-hooks: additional commands to execute at the start of container initialization
--init/-I: use init system (like systemd) inside the container.
this will make host's processes not visible from within the container. (assumes --unshare-process)
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/content/useful_tips.md#using-init-system-inside-a-distrobox
may require additional packages depending on the container image: https://github.com/89luca89/distrobox/blob/main/docs/useful_tips.md#using-init-system-inside-a-distrobox
--nvidia: try to integrate host's nVidia drivers in the guest
--unshare-devsys: do not share host devices and sysfs dirs from host
--unshare-groups: do not forward user's additional groups into the container
Expand All @@ -62,7 +62,7 @@ graphical apps (X11/Wayland), and audio.
for a list of compatible images and container managers, please consult the man page:
man distrobox
man distrobox-compatibility
or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/content/compatibility.md#containers-distros
or consult the documentation page on: https://github.com/89luca89/distrobox/blob/main/docs/compatibility.md#containers-distros

## EXAMPLES

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
Submodule duckquill updated from 000000 to d28536

0 comments on commit 5d23abd

Please sign in to comment.