Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,17 @@ serve:
--buildFuture \
--disableFastRender

production-build:
public/docs/latest:
rm -fr containerd # seems Netlify is caching this directory.
git clone --depth 1 https://github.com/containerd/containerd.git containerd
mv sphinx/* containerd/docs/
sphinx-build containerd/docs public/docs/latest

production-build: public/docs/latest
hugo \
--minify

preview-build:
preview-build: public/docs/latest
hugo \
--baseURL $(DEPLOY_PRIME_URL) \
--buildDrafts \
Expand Down
1 change: 1 addition & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ command = "make production-build"

[build.environment]
HUGO_VERSION = "0.65.3"
PYTHON_VERSION = "3.7"

[context.deploy-preview]
command = "make preview-build"
Expand Down
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Sphinx == 4.4.0
furo == 2022.3.4
myst-parser == 0.17.0
16 changes: 16 additions & 0 deletions sphinx/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
project = 'containerd'
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
html_static_path = ['_static']

# Same as our License header.
copyright = 'The contained Authors'
author = 'The containerd Authors'

# MyST (Markedly Structured Text) is a superset of CommonMark.
# https://myst-parser.readthedocs.io/en/latest/
extensions = [ 'myst_parser' ]

# Uses Furo.
# https://github.com/pradyunsg/furo
html_theme = 'furo'
43 changes: 43 additions & 0 deletions sphinx/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# containerd
Copy link
Member Author

@kzys kzys Mar 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it okay to backport documentation changes from main to release/1.x?

Yes


TBD

```{toctree}
:hidden:
:caption: Getting Started
ops.md
content-flow.md
garbage-collection.md
hosts.md
managed-opt.md
stream-processors.md
```

```{toctree}
:hidden:
:caption: Advanced
namespaces.md
remote-snapshotter.md
tracing.md
rootless.md
```

```{toctree}
:hidden:
:caption: Developing containerd client
getting-started.md
client-opts.md
```

```{toctree}
:hidden:
:caption: CRI
cri/config.md
cri/crictl.md
cri/decryption.md
cri/installation.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is outdated, being deprecated in containerd/containerd#6758

cri/proposal.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is historical (containerd/containerd#6754), no need to be linked here

cri/registry.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Outdated, not worth linking

cri/testing.md
cri/architecture.md
```