From 07d88170fa827f9907a62d6bdbf3bc0c1ffc90ee Mon Sep 17 00:00:00 2001 From: Fatih Degirmenci Date: Tue, 29 Aug 2017 01:34:29 +0200 Subject: Create the structure for the documentation This change puts the initial structure for the documentation. Change-Id: I4ff075874815bfcd1834049ae205a02b72bae75f Signed-off-by: Fatih Degirmenci --- docs/xci-developer-guide.rst | 15 +++++++++++++++ docs/xci-overview.rst | 45 ++++++++++++++++++++++++++++++++++++++++++++ docs/xci-user-guide.rst | 15 +++++++++++++++ docs/xci-wow.rst | 16 ++++++++++++++++ 4 files changed, 91 insertions(+) create mode 100644 docs/xci-developer-guide.rst create mode 100644 docs/xci-overview.rst create mode 100644 docs/xci-user-guide.rst create mode 100644 docs/xci-wow.rst diff --git a/docs/xci-developer-guide.rst b/docs/xci-developer-guide.rst new file mode 100644 index 00000000..e4e418c0 --- /dev/null +++ b/docs/xci-developer-guide.rst @@ -0,0 +1,15 @@ +.. _xci-developer-guide: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Fatih Degirmenci (fatih.degirmenci@ericsson.com) + +=================== +XCI Developer Guide +=================== + +This document will contain the developer guide. + +Introduction +============ + diff --git a/docs/xci-overview.rst b/docs/xci-overview.rst new file mode 100644 index 00000000..7c677e3c --- /dev/null +++ b/docs/xci-overview.rst @@ -0,0 +1,45 @@ +.. _xci-overview: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Fatih Degirmenci (fatih.degirmenci@ericsson.com) + +====================================== +Cross Community Continuous Integration +====================================== + + +This document will contain the overview, the pipelines, and stuff. + +Introduction +============ + +OPNFV has an advanced Continuous Integration (CI) machinery that provides support +to OPNFV community to develop, integrate, test and release the integrated +reference platform for NFV. + +During the past releases, OPNFV integrated, deployed and tested different +flavors (scenarios) of the platform in an entirely automated fashion, resulting +in feedback to OPNFV itself and the communities OPNFV works with. This enabled +communities to implement new features directly in the upstream, identify bugs +and issue fixes for them. + + +The development and release model employed by OPNFV uses stable versions of +upstream components. This helps developers and users who are after the stability +however it slows down the speed of development, testing, resulting in slower pace +in innovation. + +In order to provide means for developers to work with OpenStack master +branch, cutting the time it takes to develop new features significantly and +testing them on OPNFV Infrastructure + enable OPNFV developers to identify bugs earlier, issue fixes faster, and +get feedback on a daily basis + establish mechanisms to run additional testing on OPNFV Infrastructure to +provide feedback to OpenStack community + make the solutions we put in place available to other LF Networking Projects +OPNFV works with closely + embrace the change and apply Continuous Delivery and DevOps principles and +practices to OPNFV + + diff --git a/docs/xci-user-guide.rst b/docs/xci-user-guide.rst new file mode 100644 index 00000000..0552f4e0 --- /dev/null +++ b/docs/xci-user-guide.rst @@ -0,0 +1,15 @@ +.. _xci-user-guide: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Fatih Degirmenci (fatih.degirmenci@ericsson.com) + +============== +XCI User Guide +============== + +This document will contain the details of the sandbox and user guide. + +Introduction +============ + diff --git a/docs/xci-wow.rst b/docs/xci-wow.rst new file mode 100644 index 00000000..b0d7a677 --- /dev/null +++ b/docs/xci-wow.rst @@ -0,0 +1,16 @@ +.. _xci-wow: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) Fatih Degirmenci (fatih.degirmenci@ericsson.com) + +================== +XCI Way of Working +================== + +This document will contain the onboarding of new projects to XCI, way of working, +and release model. + +Introduction +============ + -- cgit 1.2.3-korg