Commit Graph

87 Commits

Author SHA1 Message Date
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
Daniel Nephin
cdf62f69a1 Fix usage of oci in other packages.
Signed-off-by: Daniel Nephin <dnephin@gmail.com>
2017-11-27 16:16:17 -05:00
yanxuean
81307793b7 some typo
Signed-off-by: yanxuean <yan.xuean@zte.com.cn>
2017-11-22 11:48:09 +08:00
Stephen J Day
7354a7f001
README, travis: update protobuf compiler version
Signed-off-by: Stephen J Day <stephen.day@docker.com>
2017-11-14 17:46:50 -08:00
Phil Estes
7d6017a954
Update LICENSE.docs with proper CC-BY-4.0 text
Follow-on to #1702 to correct the actual license text of the CC-BY-4.0
license. Also clean up Licenses section of README.md and link to
LICENSE.code file. Remove unecessary copyright and "rights reserved"
statement.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2017-10-31 11:46:59 -04:00
Phil Estes
015788f1d8
Fix CC-BY license reference in README.md
Fix the reference to the shortname of the correct license already being
linked to in the README.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2017-10-31 10:19:16 -04:00
Stephen J Day
639d1bdd62
README, RELEASES: update security email
Signed-off-by: Stephen J Day <stephen.day@docker.com>
2017-10-19 13:34:55 +02:00
Ian Campbell
680bab8468 Update docs with go 1.9 requirement.
re: #1632

The comment about plugins in README.md didn't seem relevant any longer so I
removed it.

Signed-off-by: Ian Campbell <ian.campbell@docker.com>
2017-10-12 15:06:36 +01:00
Stephen J Day
04ed74f4b1
README, design: update architecture diagram
Signed-off-by: Stephen J Day <stephen.day@docker.com>
2017-09-21 15:07:28 -07:00
Tao Qingyun
e1ce48d5d2 README.md: correct headers level
Signed-off-by: Tao Qingyun <845767657@qq.com>
2017-09-17 07:24:25 +08:00
Michael Crosby
2e830e0dc0 Update security reporting text
Closes #1441

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-09-15 11:32:14 -04:00
Michael Crosby
6b6ac8e9f0 Add security mailing list to readme and releases
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-08-28 17:17:50 -04:00
Michael Crosby
2052b76fa7 Change WithSpec to take SpecOpts
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-08-24 14:32:41 -04:00
Michael Crosby
c601606f84 Move spec generation to Container Create
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-08-24 10:32:16 -04:00
Stephen J Day
9827b4c1e5
RELEASES: define the release process
Define the release process for containerd and outline the components
that are and are not covered by versioning guarantees. Please read the
document for details.

Signed-off-by: Stephen J Day <stephen.day@docker.com>
2017-08-10 18:27:07 -07:00
Michael Crosby
d6c171ea89 Add getting started guide
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-08-07 09:17:27 -04:00
Derek McGowan
73bec3edea
client: rename rootfs to snapshot in "With" functions
Clarify terminology around functions which use and create
snapshots for containers.

Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2017-07-25 15:24:06 -07:00
Stephen J Day
6cfdbb2acd
README: add go report card badge
Signed-off-by: Stephen J Day <stephen.day@docker.com>
2017-07-17 17:41:02 -07:00
Michael Crosby
de10f7c467 Update readme
This moves the scope table out into a separate doc and adds a few
examples to the readme to show the feature set of containerd.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-06-20 13:19:53 -07:00
Akihiro Suda
490530be04 README.md: add GoDoc badge
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
2017-06-15 08:08:17 +00:00
Michael Crosby
fa1be5dfb8 Add RUNC.md file for runc supported version
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-05-19 11:18:18 -07:00
Phil Estes
bd432461d3
Shorten no-btrfs build tag name
Remove the `containerd_` portion of the build tag name as it is
unnecessary.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2017-05-12 09:53:57 -05:00
Phil Estes
385f56b678
Add buildtag capability to Makefile
Add the ability to set buildtags and make note in README.md about the
btrfs build tag to turn off building the btrfs snapshot support.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2017-05-12 09:53:57 -05:00
Chris Aniszczyk
f240c6d8e3 Add license scanning badge
In CNCF, we are starting to experiment with automated license scanning across our projects to ensure compliance to the CNCF IP Policy. For now, we're experimenting with FOSSA: https://app.fossa.io/reports/50dc07d0-435f-4856-9549-33a5f41bef81

Signed-off-by: Chris Aniszczyk <caniszczyk@gmail.com>
2017-05-09 09:44:24 -05:00
Michael Crosby
4f2b443a27 Rewrite imports for new github org
This rewrites the Go imports after switching to the new github org.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-04-03 14:05:44 -07:00
Michael Crosby
58b0baf585 Add logo/assets
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-03-28 09:33:33 -07:00
Michael Crosby
e4ad6fd23a Merge pull request #658 from krasi-georgiev/README.md-link-development-reports
adding a link to the development reports in the main README.md
2017-03-24 10:24:14 -07:00
Krasi Georgiev
c1f85b262b adding a link to the development reports in the main README.md
Signed-off-by: Krasi Georgiev krasi@vip-consult.solutions

the development reports are so useful so it would be great to put a  link in the main README.md

Signed-off-by: Krasi Georgiev <krasi@vip-consult.solutions>
2017-03-24 02:05:26 +02:00
Samuel Karp
473cb40a2f readme: Add metrics to scope as per #646
https://github.com/docker/containerd/pull/646

Signed-off-by: Samuel Karp <skarp@amazon.com>
2017-03-22 15:07:40 -07:00
Mike Brown
6eb6bf700f golang plugin package dependency requires 1.8
Signed-off-by: Mike Brown <brownwm@us.ibm.com>
2017-02-24 10:37:33 -06:00
Alex Ellis
598cad1bb8 Update short url http url to https.
Signed-off-by: Alex Ellis <alexellis2@gmail.com>
2017-02-21 19:51:41 +00:00
Alex Ellis
4c9e74e948 Add the short/quick/memorable URL for Slack Community from Victor Coisne.
Signed-off-by: Alex Ellis <alexellis2@gmail.com>
2017-02-21 11:53:28 +00:00
Alex Ellis
f3367c9b89 Add the short/quick/memorable URL for Slack Community from Victor Coisne.
Signed-off-by: Alex Ellis <alexellis2@gmail.com>
2017-02-21 11:52:41 +00:00
Lei Jitang
1640c297d3 typo: fix typo in README.md
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2017-01-17 23:01:23 -05:00
Michael Crosby
8bc78b2a4a Merge pull request #400 from estesp/dev-start-guide
Add simple quick-start for developers
2017-01-12 14:47:47 -08:00
Phil Estes
3695767b12
Add simple quick-start for developers
Simple documentation on getting started with the codebase.

Expects the vendor/ PR to be in place so that there are
no requirements on the developer acquiring Go dependency
packages.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2017-01-12 16:50:07 -05:00
Michael Crosby
e2eb06dd3d Remove networking from roadmap and readme
ref: https://github.com/docker/containerd/issues/362

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-01-11 16:15:01 -08:00
Gábor Lipták
be79986b4f Add travis config
Signed-off-by: Gábor Lipták <gliptak@gmail.com>
2017-01-10 19:06:40 -05:00
Yanqiang Miao
e536030f42 Fix a description error
Signed-off-by: Yanqiang Miao <miao.yanqiang@zte.com.cn>

update

Signed-off-by: Yanqiang Miao <miao.yanqiang@zte.com.cn>
2017-01-04 11:40:50 +08:00
Robert Northard
0c656ab503 Updated README.md - fixed typos
Signed-off-by: Robert Northard <robertnorthard@googlemail.com>
2016-12-27 18:58:19 +00:00
swapdisk
6c90052c7d fix typos
Signed-off-by: swapdisk <swapdisk@users.noreply.github.com>
2016-12-15 08:05:05 -06:00
Leonids Maslovs
52ae947bf6 typo in README.md / gsub 's:my the:by the:'
Minor typo fix

Signed-off-by: Leonids Maslovs <leonidms@gmail.com>
2016-12-15 00:03:55 +02:00