Rewrite the Quadlet documentation #27058
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: jankaluza The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
jankaluza
force-pushed
the
quadlet-docs
branch
from
851cdc1 to
f0837a2
Compare
| configuration passed to the container. Typically this is necessary when the | ||
| host DNS configuration is invalid for the container (e.g., **127.0.0.1**). When this | ||
| is the case the **--dns** flag is necessary for every run. | ||
| is the case the << '**DNS=.**' if is_quadlet else '**--dns**' >> flag is necessary for every run. |
There was a problem hiding this comment.
It might be md ignorance on my part, but I'm not sure what this line does.
There was a problem hiding this comment.
looking at examples below, shouldn't the if be the first thing here?
There was a problem hiding this comment.
The inline condition really has the "foo" if something else "bar" syntax. I can change it to anything else if we think this is confusing.
| more arguments after a `podman run <image> <arguments>` invocation. | ||
|
|
||
| The format is the same as for [systemd command lines](https://www.freedesktop.org/software/systemd/man/systemd.service.html#Command%20lines), | ||
| However, unlike the usage scenario for similarly-named systemd `ExecStart=` verb |
There was a problem hiding this comment.
| However, unlike the usage scenario for similarly-named systemd `ExecStart=` verb | |
| However, unlike the usage scenario for similarly-named systemd `ExecStart=` verbs |
There was a problem hiding this comment.
Shouldn't it be a singular? There's just single ExecStart verb. If it should really be a plural, I will also change the operates to operate in the next line, ok?
There was a problem hiding this comment.
Again, like I commented before on the other PR and I had to fix this up in #27002
Never delete podman-systemd.unit.5 please. It should contain the content of podman-quadlet.7 and there should be never a podman-quadlet.7 IMO. It is confusing since there is podman-quadlet.1 already.
I have not double check the actual content
|
Oh and for commit style the fix types commits should just be squashed, we merge the commits as is. |
This commit does the following: - Splits the podman-systemd.unit.5.md into multiple files - one for each quadlet file type. - Adds the podman-quadlet-basic-usage.7.md for quadlet examples. - Majority of the text in the new files is copied from the podman-systemd.unit.5.md - Adds support for very simple condditional in the markdown_preprocess. - Uses new logic in markdown_preprocess in options/*.md to use a single .md file for both podman subcommands man-pages and quadlet man-pages. This deduplicates the Quadlet man-pages a lot. - Adds new `@@option quadlet:source.md`` preprocess command to import such .md files from options directory. Signed-off-by: Jan Kaluza <[email protected]>
jankaluza
force-pushed
the
quadlet-docs
branch
from
44d433c to
f48c851
Compare
jankaluza
changed the title
|
|
||
| ## Expected Output: | ||
|
|
||
| For rootles, check logs using: |
|
|
||
| For rootful use: | ||
| ```bash | ||
| sudo cp hello.container ~/etc/containers/systemd/ |
There was a problem hiding this comment.
~/etc/containers/systemd/
remove ~
| For rootless use: | ||
| ```bash | ||
| systemctl --user daemon-reload | ||
| systemctl --user start hello.service | ||
| ``` | ||
|
|
||
| For rootful use: | ||
| ```bash | ||
| sudo systemctl daemon-reload | ||
| sudo systemctl enable --now hello.service | ||
| ``` |
There was a problem hiding this comment.
start is used for rootless.
enable --now is used for rootful.
I'm not sure if the difference is intentional or not.
|
|
||
| ``` | ||
| [Install] | ||
| WantedBy=multi-user.target default.target |
There was a problem hiding this comment.
The document uses different values for WantedBy=
WantedBy=multi-user.target
WantedBy=default.target
WantedBy=multi-user.target default.target
Maybe this could be confusing for a reader? With more explanation it would be less confusing. Alternatively, use less variations.
4 participants
This commit does the following:
podman subcommands man-pages and quadlet man-pages. This deduplicates the Quadlet man-pages a lot.
Does this PR introduce a user-facing change?