Commit Graph

18 Commits

Author SHA1 Message Date
James O. D. Hunt
117cb58609 docs: Disable initrd in dev guide
Add details on how to disable the `initrd` config option to ensure the
base system as documented is functional.

Fixes #42.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-03-28 17:35:41 +01:00
Eric Ernst
33ade410f3 Merge pull request #27 from bergwolf/api-design
design: add api design doc
2018-03-27 07:06:25 -07:00
Peng Tao
fa9a5b8d9e design: add api design doc
To fulfill the kata design requirements, and based on the disscusion on
Virtcontainers API extentions, runtime API early sketch and runtime API
comparison, this commit added the high level design of the kata runtime
library API.

fixes: #26

Signed-off-by: Peng Tao <bergwolf@gmail.com>
2018-03-24 11:30:35 +08:00
Eric Ernst
893d9d1bb1 Merge pull request #30 from jodh-intel/add-dev-guide
docs: Add developer guide
2018-03-21 09:59:40 -07:00
James O. D. Hunt
2ab1a3f260 docs: Add developer guide
Move the developer guide from the wiki "in-tree".

Fixes #29.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-03-21 16:57:51 +00:00
Sebastien Boeuf
f43d4f665c Merge pull request #17 from egernst/reqts
requirements: add initial document
2018-03-09 10:02:28 -08:00
Eric Ernst
3839bf4e71 requirements: add initial document
Adding initial kata requirements list, based off of discussion from
kata-containers/runtime issue #31.

Fixes: #18

Signed-off-by: Eric Ernst <eric.ernst@intel.com>
2018-03-08 13:01:26 -08:00
Eric Ernst
3bb70f65a9 Merge pull request #14 from gnawux/desgin
create directory for design documents
2018-03-06 14:57:31 -08:00
Eric Ernst
fc28cdc28d Merge pull request #12 from jodh-intel/add-coc-doc
docs: Add code of conduct doc
2018-02-27 08:34:37 -08:00
Wang Xu
fd579088db create directory for design documents
Fixes #13

Signed-off-by: Wang Xu <gnawux@gmail.com>
2018-02-26 18:24:55 +08:00
James O. D. Hunt
c08294fa0d docs: Add code of conduct doc
Add the standard code of conduct document.

Fixes #11.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-02-06 10:39:00 +00:00
James O. D. Hunt
7f53e41fd8 Merge pull request #5 from jodh-intel/docs-require-doc-team-signoff
CI: Require doc team signoff for doc changes
2018-02-02 07:11:40 +00:00
James O. D. Hunt
645b4cf64d Merge pull request #9 from ydjainopensource/minimalContributing
Docs : Add minimal contribution guidelines
2018-01-30 17:38:53 +00:00
Yash Jain
48048056da cs : Add minimal contribution guidelines
Fixes : #8

See : kata-containers/community#5

Signed-off-by: Yash Jain <ydjainopensource@gmail.com>
2018-01-30 22:14:52 +05:30
James O. D. Hunt
f822e0f80b CI: Require doc team signoff for doc changes
Require an additional approval from a `documentation` team member for
PRs containing documentation changes.

Fixes #4.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-24 13:42:26 +00:00
James O. D. Hunt
fd16a96237 Merge pull request #3 from jodh-intel/enable-pullapprove
CI: Enable pullapprove
2018-01-24 13:40:03 +00:00
James O. D. Hunt
72e41a0722 CI: Enable pullapprove
Require two approvals from documentation team members before a PR
can land.

The configuration file is the same as those used for the other repos,
except for the approval team name.

Fixes #2.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-02 17:34:46 +00:00
James O. D. Hunt
20fbb5a721 Initial commit 2017-12-21 13:41:45 +00:00