Skip to content

Documentation: document hooks / provide a pointer to OCI doc from podman doc? #27281

@jerabaul29

Description

@jerabaul29

When working on getting what is discussed in #27099 to work, one of the difficulties I got was finding which stage to use for my hooks.

I was googling / searching the documentation for keywords like "podman hooks", "podman hooks stage", but all I got (maybe I missed something?) was stuff like:

In the end, my LLM suggested using the createContainer stage, and it worked. Once I first knew that I should google "createContainer", I got to the OCI container documentation:

Now a posteriori it makes sense - podman implements the OCI specification, including OCI hooks, so it makes sense that hooks are described there. But as a n00b, it was a bit hard to think a priori in this way, and I spent quite a bit of time being lost since searches like "podman hook" was not very useful.

Hence my question: would it make sense to have a podman documentation page about hooks, even if it is basically just a stub saying that podman implements OCI hooks, and pointing to the OCI hooks documentation? At least this would have been helpful for me :) .

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationIssue or fix is in project documentationstale-issuetriagedIssue has been triaged

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions