void-docs
void-docs copied to clipboard
void-linux
podman.md: Added containers and VMs section with starting podman doc …
I am looking for a couple suggestions regarding this doc.
- Should I add a section about the podman man pages? Seems like a good move.
- Is it okay that the podman command to test the installation is something relating to fedora. It seems to be more an apache web server, and it is the one in the podman docs on their website. Did not know if the void team wanted it to be something a little more distro agonist.
-- NOTE to self: add the command to stop the test container -->
sudo podman stop -l - I do not like the error section in this. Saying to run a command as sudo to fix an error makes my blood pressure raise at least 10 points. I will absolutely edit that section (i see it more of a placeholder). I could use some guidance on what to put. The podman doc says
The code samples are intended to be run as a non-root user, and use sudo where root escalation is required.
They list the command for the test container as
$ podman run -dt -p 8080:8080/tcp registry.fedoraproject.org/f29/httpd
Emphasis on the $. Note that command does return the documented error on my system. Their doc makes no reverence to editing permissions, groups etc to allow podman to run the above command as user. I could use some guidance on cleaning up that section.
After I have feedback, I will edit accordingly and resubmit!
As much as possible, we should be trying to combine things into a single page; i've been doing a lot of consolidation of late, to try to reduce the number of short pages (e.g. the "XBPS Package Manager" section, which has been heavily consolidated). @ericonr and i feel that around 150 lines is the threshold at which we should start considering whether or not to split the page. Would combining the current Docker and Podman content exceed that threshold?
Should I add a section about the podman man pages? Seems like a good move.
Rather than having a distinct subsection, there should be links to the relevant man pages as part of the text, e.g.
To remove a package, use [xbps-install(1)](https://www.voidlinux.org/xbps-install.1):
# xbps-install <unneeded-package>
Is it okay that the podman command to test the installation is something relating to fedora. It seems to be more an apache web server, and it is the one in the podman docs on their website. Did not know if the void team wanted it to be something a little more distro agonist.
Is that the only way to test the installation? If so, that's fine; if not, i feel the command should be something more general.
As a general point, don't use sudo in commands; instead, use # or $ to indicate whether or not the command needs to be run with root privileges (cf. the style guide). Unfortunately, i don't have any experience with Podman to know how to best handle the specific error issue you mentioned.
Fair enough on the sudo. I have forgotten about that! that is an easy fix. Let me look into some other basic commands. That was the one off the website but you are right there has to be a similar and more direct one. Docker had something that printed hello world from docker so let me look for something like that.
I think docker and podman together might exceed that threshold just a little bit, but let me check on that. If it is a little over, they probably could still go together
So for the simple example, I have one of two ways of doing it. We can run the docker hello world example via
Adding docker.io to the registeries search:
see podman doc.
Or we can run it inline like the code block above like so:
podman run docker.io/library/hello-world
Is one preferable in this case? Adding docker.io to the registeries search enables on to more quickly and efficiently use docker with podman whereas the one liner is clearer just for the getting started example.
Is there anything void specific to document? Otherwise I don't really see the need to document how to use the podman command.
It is less about how to use the command and more about testing that podman is indeed working.
@Frick-David: Ping? Are you able to continue working on this, or would you perhaps like me to take it over?