38 Commits

This Branch

This Branch

All Branches

Author	SHA1	Message	Date
James O. D. Hunt	3e8400eee9	docs: Remove spec command limitation ... Update the limitations document to remove the `spec` command limitation (implemented on https://github.com/kata-containers/runtime/pull/196). Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>	2018-04-18 11:49:04 +01:00
James O. D. Hunt	4aa57d2e2c	docs: Add links to README ... Add links for the dev guide and limitations doc to the `README`. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>	2018-04-18 11:49:04 +01:00
James O. D. Hunt	6200d14e4a	docs: Add limitations doc ... Add the list of known limitations. Fixes #31. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>	2018-04-18 11:49:01 +01:00
James O. D. Hunt	37ab12bcb4	Merge pull request #54 from nitkon/patch-3 ... dev-guide: Fix minor typos	2018-04-16 18:46:43 +01:00
Eric Ernst	ccc949f086	Merge pull request #50 from nitkon/patch-2 ... dev-guide: Conditionally add kata-runtime as suffix	2018-04-16 08:35:14 -07:00
Nitesh Konkar	727a16d468	dev-guide: Fix minor typos ... Fix minor typos in the development guide. Fixes #53. Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>	2018-04-16 20:58:22 +05:30
Eric Ernst	d03837fc9f	Merge pull request #45 from bergwolf/initrd ... dev-guide: add guide to build and setup initrd image	2018-04-16 07:12:29 -07:00
Nitesh Konkar	d99af8fbe3	dev-guide: Conditionally add kata-runtime as suffix ... If kata-runtime is already added as a runtime to kata-containers.conf then you need not add it again. Fixes: #49 Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>	2018-04-10 09:26:58 +05:30
Peng Tao	988bbdec59	dev-guide: fix rootfs image rootfs dir notion ... Set ROOTFS_DIR so that we do not create distro-specific dir names. Signed-off-by: Peng Tao <bergwolf@gmail.com>	2018-04-09 22:13:01 +08:00
Peng Tao	d87be6c94a	dev-guide: add guide to build and setup initrd image ... Optionaly, one can build an initrd image and configure kata runtime to use it. Fixes: #44 Signed-off-by: Peng Tao <bergwolf@gmail.com>	2018-04-09 22:12:58 +08:00
Eric Ernst	2ac900f2d8	Merge pull request #41 from jodh-intel/fix-dev-guide-runtime-link ... docs: Fix runtime link in dev guide	2018-03-28 11:07:39 -07:00
James O. D. Hunt	f44248c67c	Merge pull request #43 from jodh-intel/dev-guide-disable-initrd ... docs: Disable initrd in dev guide	2018-03-28 17:40:08 +01:00
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	a6de7edc53	Merge pull request #39 from jodh-intel/dev-guide-improve-agent-debug ... docs: Improve command to enable agent debug	2018-03-28 08:41:02 -07:00
Eric Ernst	4d8e58e5da	Merge pull request #35 from jodh-intel/dev-guide-mention-collect-script ... docs: Mention collect script in dev guide	2018-03-28 08:37:50 -07:00
Eric Ernst	5643232ce3	Merge pull request #37 from jodh-intel/improve-readme ... docs: Embellish README	2018-03-28 08:06:26 -07:00
James O. D. Hunt	00ed3a249d	docs: Fix runtime link in dev guide ... The table of contents showed an incorrect link for building and installing the runtime. Fixes #40. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>	2018-03-28 10:26:35 +01:00
James O. D. Hunt	3b71b57286	docs: Improve command to enable agent debug ... Change the command to enable agent debug slightly so that even if the config file specifies kernel parameters, the command will successfully enable the agent debug. Fixes #38. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>	2018-03-27 17:55:47 +01:00
James O. D. Hunt	d9a77b3de2	docs: dev guide whitespace fix ... Add a blank line to the dev guide. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>	2018-03-27 17:55:25 +01:00
James O. D. Hunt	7111e03021	docs: Mention collect script in dev guide ... Add details of the collect script in under the "Troubleshoot" section. Fixes #34. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>	2018-03-27 17:32:48 +01:00
James O. D. Hunt	2b40a280b5	docs: Embellish README ... Add some brief explanatory text and a few pointers. Fixes #36. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>	2018-03-27 16:08:36 +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