Skip to content

Minor issue in Getting Started doc #6891

@2000yeshu

Description

@2000yeshu

Description

In the Getting Started doc located at containerd/docs/getting-started.md, in this block https://github.com/containerd/containerd/blob/main/docs/getting-started.md#creating-an-oci-spec-and-container, its written that "use the runtime information in the spec that was just created" but have are actually not created a OCI spec instance instead creating it in the caller for NewContainer itself. This is not that big of a bug but can be confusing for people who are just getting strted like me. I think this doc is based on a previous version of containerd when the contained class used to provide the method containerd.GenerateSpec( like inhttps://blog.mobyproject.org/getting-started-with-containerd-a81fa090982f ).

Steps to reproduce the issue

Describe the results you received and expected

its written that "use the runtime information in the spec that was just created", but it should be written something like "we will create a new spec with the runtime information, and we will allocate a new read-write snapshot so the container can store any persistent information."

What version of containerd are you using?

1.4.13

Any other relevant information

No response

Show configuration if it is related to CRI plugin.

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions