Add containerd's docs directory

[kzys]

Signed-off-by: Kazuyoshi Kato [email protected]

[kzys]

The preview website is https://deploy-preview-121--containerd-io.netlify.app/docs/latest/getting-started/.

Right now, it doesn't look great compared to #120, but we can improve the look & feel by adopting Hugo's documentation-oriented themes like https://www.docsy.dev/.

It would be better to not complicate the stack by having multiple documentation generators.

[AkihiroSuda]

Can we remove /docs/getting-started and redirect it to /docs/latest/getting-started?

[AkihiroSuda]

Seems broken

[kzys]

Fixed the broken menu.

Regarding the redirection, the Getting Started guide needs to have metadata like https://github.com/containerd/containerd.io/blob/main/content/docs/getting-started.md. Let me fix other parts first.

[AkihiroSuda]

Fixed the broken menu.

The new docs don't seem reachable from the top page

It would be better to not complicate the stack by having multiple documentation generators.

If sphinx is easier to use than hugo, we can completely replace hugo with sphinx.
Just reopening #120, adding logo, and redirecting / to /docs/latest would be enough as the first step.

[kzys]

The new docs don't seem reachable from the top page

Yes. I'd like to add at least add <title> before making them reachable. But to do that, I need to edit files on containerd/containerd first.

If sphinx is easier to use than hugo, we can completely replace hugo with sphinx.

Honestly both are not that different in terms of the ease of use. Hugo may work better for us at this time since we already have Hugo-based website. Migrating that to Sphinx may not bring us much value.

[AkihiroSuda]

Is this still planned?

[AkihiroSuda]

Alternative: https://akihirosuda.github.io/containerd-website-draft/

• Render the markdown on the client side #149

[kzys]

I've updated this PR finally.

The preview site is https://deploy-preview-121--containerd-io.netlify.app/. The docs from containerd/containred is linked from https://deploy-preview-121--containerd-io.netlify.app/docs/getting-started/.

I'm planning to merge https://deploy-preview-121--containerd-io.netlify.app/docs/ and https://deploy-preview-121--containerd-io.netlify.app/docs/getting-started/, since the latter is pretty short.

[samuelkarp]

I like this approach. It doesn't have to be in this PR, but we should also consider doing something like https://github.com/containerd/containerd.io/blob/main/.github/workflows/sync-releases.yml so it stays reasonably up-to-date too.

[haddscot]

picking this up – gonna rebase and implement the doc syncing