Commit Graph

128 Commits

Author SHA1 Message Date
Phil Estes
5e4b033ecd
Update README.md repo->org
Update wording; but really I'm trying to test something with CI
runs/automation.

Signed-off-by: Phil Estes <estesp@amazon.com>
2021-11-19 12:23:59 -05:00
Derek McGowan
0fbcf9b97f
Merge pull request #5847 from kzys/master-to-main
docs: rename main to master
2021-08-10 15:06:06 -07:00
Kazuyoshi Kato
1c47fb17f3 docs: remove FOSSA's badge
The automated scan doesn't work correctly and it would give
contributors a doubt regarding containerd's license.

Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
2021-08-10 09:48:01 -07:00
Kazuyoshi Kato
bc4cea4e44 docs: rename main to master
containerd and opencontainers/image-spec have renamed its main branch
from "master" to "main"

Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
2021-08-10 09:42:16 -07:00
Derek McGowan
95c708572f
Update documenation for OCI distribution 1.0
Signed-off-by: Derek McGowan <derek@mcg.dev>
2021-07-01 17:24:08 -07:00
Mike Brown
560e7d4799 fixing some doc links
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2021-06-21 18:24:47 -05:00
Derek McGowan
0ba7303ee8
Prepare default branch rename
Use renamed branch for containerd/project

Signed-off-by: Derek McGowan <derek@mcg.dev>
2021-05-06 09:28:42 -07:00
Furkan
0b786908c0
doc: add missing namespaces package
Currently, we can not reproduce the given Namespaces
section examples written in the README, since it's
not clear to which package should we import to.

Signed-off-by: Furkan Turkal <furkan.turkal@trendyol.com>
2021-05-04 22:04:01 +03:00
Sebastiaan van Stijn
8325ba5d36
Separate runc binary version from libcontainer version
Now that the dependency on runc (libcontaienr) code has been reduced
considerably, it is probbaly ok to cut the version dependency between
libcontainer and the runc binary that is supported.

This patch separates the runc binary version from the version of
libcontainer that is defined in go.mod, and updates the documentation
accordingly.

The RUNC_COMMIT variable in the install-runc script is renamed to
RUNC_VERSION to encourage using tagged versions, and the Dockerfile
in contrib is updated to allow building with a custom version.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-03-10 13:41:12 +01:00
Wei Fu
3299c5560d
Merge pull request #4967 from dmcgowan/cleanup-root
Move documentation and helper directories out of root
2021-01-24 15:08:19 +08:00
Aditi Sharma
d09bf18862 Clean Up Doc and fix some broken links
Signed-off-by: Aditi Sharma <adi.sky17@gmail.com>
2021-01-20 15:45:43 +05:30
Derek McGowan
7dffdfa560
Move documentation and helper directories out of root
Signed-off-by: Derek McGowan <derek@mcg.dev>
2021-01-12 12:19:50 -08:00
Shengjing Zhu
91dc69ee43 docs: point cri release tarball to github release page
Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2021-01-03 17:50:40 +08:00
Shengjing Zhu
b4c604692e docs: Move autocomplete distribution section next to install section
Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2020-12-22 13:22:16 +08:00
Shengjing Zhu
1cc3c7f4a2 docs: Remove appveyor badge
No longer used

Signed-off-by: Shengjing Zhu <zhsj@debian.org>
2020-12-22 13:22:16 +08:00
James Jackson
ca292da14b
Requested Changes
* Consolidating and improving language

Signed-off-by: James Jackson <james.sorley.jackson@gmail.com>
2020-12-12 15:22:38 -06:00
James Jackson
09241fd21c
Mention built-in CRI support in README
Signed-off-by: James Jackson <james.sorley.jackson@gmail.com>
2020-12-12 15:22:38 -06:00
kwgchi
b69f36aa13 Fix some typos and grammars
Signed-off-by: ekrecker <eiichi.kendoruki@gmail.com>
2020-11-30 22:53:43 +09:00
Wei Fu
9756153170 README.md: Use go.dev instead of godoc
Signed-off-by: Wei Fu <fuweid89@gmail.com>
2020-10-31 08:10:05 +08:00
Mike Brown
6f4fe8245f add help wanted, update slack
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2020-08-31 12:41:28 -05:00
milkwine
9898dc2a64 Code about task in "README.md" is out of date
Signed-off-by: SiYu Zhao <d.chaser.zsy@gmail.com>
2020-05-12 16:15:13 +08:00
Phil Estes
e3bc5c487a
Use GH Actions CI status for badge
Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2020-04-13 12:43:46 -04:00
Phil Estes
0dd6d24d2a
Fix reference to LICENSE in README.md
Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2020-02-13 00:10:49 -05:00
Maksym Pavlenko
32ef2e6305 Update README
Add "Nightly builds" section and status badge.

Signed-off-by: Maksym Pavlenko <makpav@amazon.com>
2019-11-14 15:48:02 -08:00
Phil Estes
3bf461ae8e
Move autocomplete files to contrib/
Since recent versions of `vndr` are going to remove the autocomplete
scripts from the urfave vendored content, we will just move them into
`contrib/` and reference them in the documentation from that location.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2019-10-21 13:57:56 -04:00
Phil Estes
e33f70385b
Add more detail on releases
Add more detail to the README.md where releases are found and also add
the documentation for how to use the new auto-completion capabilities
provided by urfave and enabled in a recent PR.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2019-10-03 09:52:03 -04:00
Mike Brown
62e9e11696 switch to a working link
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2019-06-18 09:53:43 -05:00
Sarang Joshi
2f22d8e677 Fix broken link to containerd logo
Signed-off-by: Sarang Joshi <sarangj@msn.com>
2019-05-03 11:56:46 -07:00
Ace-Tang
f014adfa17 readme: fix example for checkpoint
Signed-off-by: Ace-Tang <aceapril@126.com>
2019-02-02 19:57:36 +08:00
Phil Estes
a79879e9dd
Add security audit report to README
Also remove weekly development reports section from README as those are
not being produced regularly at this time.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2019-01-04 09:56:03 -05:00
Phil Estes
18363d0c95
Add ADOPTERS.md file
Per request of the CNCF, adding known containerd adopters to GitHub
project.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2018-11-05 14:12:27 -05:00
Mike Brown
fa912a79bb update link for slack invite
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2018-10-31 12:58:50 -05:00
lucperkins
0c8a5ff72e Update banner URL
Signed-off-by: lucperkins <lucperkins@gmail.com>
2018-10-17 12:55:10 -07:00
Phil Estes
6f3288333c
Move common repository details to project references
Now that all the content is set up appropriately in the
containerd/project repo, remove local copies and point to the common
project content from the containerd README.md

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2018-10-15 09:05:37 -04:00
Michael Crosby
0f99d24d3d Update slack invite link for direct signup
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2018-09-17 14:12:23 -04:00
Justin Terry (VM)
85eb2c3c83 Add Windows build status
Signed-off-by: Justin Terry (VM) <juterry@microsoft.com>
2018-08-29 15:43:07 -07:00
Wei Fu
56a51ac945 README.md: add missing banner
All the website files has been moved to the containerd.io. The banner
should use the containerd.io file.

Signed-off-by: Wei Fu <fhfuwei@163.com>
2018-08-24 11:24:15 +08:00
Derek McGowan
ca71484793
Merge pull request #2480 from dmcgowan/proxy-plugin-doc
Document plugins
2018-07-30 11:23:24 -07:00
Felix Abecassis
e22f19618c Remove reference to WithExit in README
This function was removed from the containerd package in da1b5470cd

Signed-off-by: Felix Abecassis <fabecassis@nvidia.com>
2018-07-27 15:16:43 -07:00
Derek McGowan
3e657de3af
Document plugins
Add plugins documentation to root.
Mention configuring proxy plugins and runtime plugins.

Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2018-07-25 23:28:09 -07:00
Phil Estes
34c032d98f
Reference new location for images
containerd images moved based on website dir layout changes.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2018-05-16 15:10:42 -04:00
Andrea Kao
c0c92f6b34 Edit Containerd license info so GitHub recognizes it
GitHub uses a library called Licensee to identify a project's license
type. It shows this information in the status bar and via the API if it
can unambiguously identify the license.

This commit removes the LICENSE.docs file and updates the README to
refer readers directly to the CC-BY-4.0 license on the Creative Commons
site. It also updates the copyright reference to "The containerd
Authors" and removes a reference to copyright year in the LICENSE file
(per a recommendation from the CNCF).

This change allows Licensee to successfully identify the license
type of Containerd's codebase as Apache 2.0.

Signed-off-by: Andrea Kao <eirinikos@gmail.com>
2018-04-02 12:31:15 -07:00
Michael Crosby
f6f0e258f6 Add CCI badge for containerd
Closes #1539

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2018-01-09 10:14:09 -05:00
weekface
284860d9e3 Fix some wrong links
Signed-off-by: weekface <weekface@gmail.com>
2018-01-08 10:40:09 +08:00
Jess Valarezo
b284da3175 docs: update BUILDING and README
Signed-off-by: Jess Valarezo <valarezo.jessica@gmail.com>
2017-12-04 20:02:18 -08:00
Jess Valarezo
26012df467 add table of contents to readme
Signed-off-by: Jess Valarezo <valarezo.jessica@gmail.com>
2017-12-04 17:59:07 -08:00
Jess Valarezo
350e8156bf docs: add cio import
Signed-off-by: Jess Valarezo <valarezo.jessica@gmail.com>
2017-12-04 15:17:59 -08:00
Ace-Tang
aca8e15916 docs: fix usage of cio package in docs
Signed-off-by: Ace-Tang <aceapril@126.com>
2017-12-05 00:07:08 +08:00
Kenfe-Mickael Laventure
9d759203b0
Fix flexible kernel version
Signed-off-by: Kenfe-Mickael Laventure <mickael.laventure@gmail.com>
2017-11-30 17:31:00 -08:00
Phil Estes
a87062efdd
Add runtime requirements section to README
Add details on kernel version, criu, snapshotters, and links to existing
sections for developers/criu details.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2017-11-30 11:12:33 -05:00