Use Sphinx to manage docs/latest/ #120
Conversation
kzys
force-pushed
the
sphinx
branch
4 times, most recently
from
d6023fd
to
b474949
Compare
This commit adds https://containerd.io/docs/latest/, based on github.com/containerd/containerd's docs directory. We would need docs/1.6/, docs/1.5/, ... eventually. But for now we can start from the tip of the main branch. Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
| @@ -0,0 +1,43 @@ | |||
| # containerd | |||
There was a problem hiding this comment.
For docs/latest, we should have this index.md and possibly conf.py in containerd/containerd.
For released versions such as 1.6, I'd like to have versioned documents like https://www.envoyproxy.io/docs. However we generally backport only security fixes. So just using the existing branches wouldn't work.
Is it okay to backport documentation changes from main to release/1.x?
There was a problem hiding this comment.
Is it okay to backport documentation changes from main to release/1.x?
Yes
|
FYI the preview site is https://deploy-preview-120--containerd-io.netlify.app/docs/latest/. |
|
Is this still draft? |
|
Overall I'm LGTM on this direction; we have some things to figure out with how we point to this site and the fact that the "UI" /design isn't really aligned with the overall website, but I'm fine with that generally. At some point it would be nice to make it like going between pkg.go.dev and go.dev; that top bar is consistent across both, even though the pkg site (I assume) is generated based on doc input from the source. |
|
We should now remove https://github.com/containerd/containerd.io/blob/main/.github/workflows/sync-releases.yml , but it can be a separate PR. |
| cri/config.md | ||
| cri/crictl.md | ||
| cri/decryption.md | ||
| cri/installation.md |
There was a problem hiding this comment.
This is outdated, being deprecated in containerd/containerd#6758
| cri/crictl.md | ||
| cri/decryption.md | ||
| cri/installation.md | ||
| cri/proposal.md |
There was a problem hiding this comment.
This is historical (containerd/containerd#6754), no need to be linked here
| cri/decryption.md | ||
| cri/installation.md | ||
| cri/proposal.md | ||
| cri/registry.md |
|
This is superseded by #121. |
This commit adds https://containerd.io/docs/latest/, based on
github.com/containerd/containerd's docs directory.
We would need docs/1.6/, docs/1.5/, ... eventually. But for now
we can start from the tip of the main branch.