Merge pull request #24 from open-ness/jekyll-doc-files

Merge Jekyll documentation files to OpenNESS

404.html

@@ -0,0 +1,40 @@
+---
+layout: openness
+---
+<style>
+    .error-page{
+        color: #555;
+        font-size: 16px;
+        line-height: 32px;
+        font-family: 'Montserrat', sans-serif;
+    }
+
+    .error-page h2 {
+        text-align: left;
+        text-transform: uppercase;
+        font-size: 30px;
+        margin-bottom: 10px;
+        color: #193f6e;
+        font-weight: 600;
+    }
+
+    @media (max-width:768px){
+        .error-page{
+         font-size: 14px;   
+        }
+    }
+</style>
+<div class="container">
+    <div class="error-page">
+        <h2>Page Not Found!</h2>
+        <p><strong>Sorry, you may not be able to visit requested page because of following reasons:</strong></p>
+        <ol>
+            <li>An <strong>out-of-date bookmark/favourite</strong></li>
+            <li>A search engine that has an <strong>out-of-date listing for this site</strong></li>
+            <li>A <strong>mistyped address</strong></li>
+            <li>You have <strong>no access</strong> to this page</li>
+            <li>The requested resource was not found.</li>
+            <li>An error has occurred while processing your request.</li>
+        </ol>
+    </div>
+</div>

_data/navbars/applications-onboarding.yml

@@ -0,0 +1,28 @@
+title: "Application Onboarding"
+path: /applications-onboard/
+order: 2
+section:
+  - title: Network Edge Applications Onboarding
+    path: /doc/applications-onboard/network-edge-applications-onboarding
+    meta_title: OpenNESS Network Edge Application On-Boarding Process
+    meta_description: OpenNESS application on-boarding process for the Network Edge provides instructions on how to deploy an application from the Edge Controller to Edge Nodes in the cluster.
+
+  - title: OnPremises Applications Onboarding
+    path: /doc/applications-onboard/on-premises-applications-onboarding
+    meta_title: OpenNESS OnPremises Mode Application On-Boarding Process
+    meta_description: OpenNESS application on-boarding process for the OnPremises mode provides instructions on how to deploy an application from the Edge Controller on Edge Nodes.
+
+  - title: OpenNESS Edge DNS
+    path: /doc/applications-onboard/openness-edgedns
+    meta_title: OpenNESS Provides Edge DNS and Supports DNS Microservice
+    meta_description: OpenNESS edge platform is required to provides access to DNS. The edge platform receives the application DNS rules from the controller.
+
+  - title: OpenNESS Interface Service
+    path: /doc/applications-onboard/openness-interface-service
+    meta_title: OpenNESS Applications Onboard - OpenNESS Interface Service
+    meta_description: OpenNESS Interface service is an application running in Kubernetes pod on every worker node of OpenNESS Kubernetes cluster and provides OVS bridge, enabling external traffic scenarios.
+
+  - title: Using OpenNESS CNCA
+    path: /doc/applications-onboard/using-openness-cnca
+    meta_title: OpenNESS 4G/LTE Core Configuration Using CNCA
+    meta_description: CNCA provides a kubectl plugin to configure the 4G/LTE Core network. Kubernetes adopts plugins concepts to extend its functionality executes CNCA related functions.

_data/navbars/cloud-adapters.yml

@@ -0,0 +1,13 @@
+title: "Cloud Adapters"
+path: /cloud-adapters/
+order: 8
+section:
+  - title: OpenNESS AWS Greengrass
+    path: /doc/cloud-adapters/openness_awsgreengrass
+    meta_title: OpenNESS Integration with AWS Greengrass
+    meta_description: OpenNESS is an open source software platform that enables easy orchestration of edge services across diverse network platform and access technologies in multi-cloud environments.
+
+  - title: OpenNESS Baidu Cloud
+    path: /doc/cloud-adapters/openness_baiducloud
+    meta_title: OpenNESS Integration with Baidu OpenEdge
+    meta_description: OpenNESS can integrate with Baidu Cloud Connector, OpenEdge which is Edge IoT Gateway. Baidu Edge solution is called as Baidu® IntelliEdge.

_data/navbars/core-network-4G-5G.yml

@@ -0,0 +1,18 @@
+title: "Core Network - 4G and 5G"
+path: /core-network/
+order: 4
+section:
+  - title: OpenNESS EPC
+    path: /doc/core-network/openness_epc
+    meta_title: OpenNESS Edge Cloud Deployment with 3GPP 4G LTE CUPS of EPC
+    meta_description: OpenNESS is an open source edge computing platform that enables Service Providers and Enterprises to deploy applications and services on a network edge.
+
+  - title: OpenNESS NGC
+    path: /doc/core-network/openness_ngc
+    meta_title: OpenNESS Edge Cloud Deployment with 3GPP 5G Stand Alone
+    meta_description: OpenNESS NGC provides reference REST-based APIs along with 3GPP standard traffic influencing APIs to address some of these major challenges in 5G edge deployments.
+
+  - title: OpenNESS UPF
+    path: /doc/core-network/openness_upf
+    meta_title: OpenNESS User Plane Function UPF
+    meta_description: User Plane Function is the evolution of Control and User Plane Separation which part of the Rel.14 in Evolved Packet core. CUPS enabled PGW to be split into PGW-C and PGW-U.

_data/navbars/dataplane.yml

@@ -0,0 +1,23 @@
+title: "Dataplane"
+path: /dataplane/
+order: 6
+section:
+  - title: OpenNESS InterAPP
+    path: /doc/dataplane/openness-interapp
+    meta_title: InterApp Communication Support in OpenNESS
+    meta_description: OpenNESS provides InterApp Communication support for both the On-Premises and Network edge modes of OpenNESS.
+
+  - title: OpenNESS OVN
+    path: /doc/dataplane/openness-ovn
+    meta_title: OpenNESS Support for OVS as Dataplane with OVN
+    meta_description: The primary objective of supporting OVN/OVS in OpenNESS is to demonstrate the capability of using a standard dataplane like OVS for an Edge Compute platform. 
+
+  - title: OpenNESS NTS
+    path: /doc/dataplane/openness-nts
+    meta_title: OpenNESS NTS - Dataplane support for Edge Cloud between ENB and EPC Deployment
+    meta_description: OpenNESS NTS is a Dataplane component that provides a network traffic control service and a data forwarding service to mobile edge applications, specifically for S1-U deployments.
+
+  - title: OpenNESS Userspace CNI
+    path: /doc/dataplane/openness-userspace-cni
+    meta_title: OpenNESS Userspace CNI, Setup Userspace CNI
+    meta_description: Userspace CNI is a Container Network Interface Kubernetes plugin that was designed to simplify the process of deployment of DPDK based applications in Kubernetes pods.

_data/navbars/edge-applications.yml

@@ -0,0 +1,19 @@
+title: "Edge Applications"
+path: /applications/
+order: 7
+section:
+  - title: OpenNESS Application Guide
+    path: /doc/applications/openness_appguide
+    meta_title: Openness Application Development and Porting Guide
+    meta_description: OpenNESS is an open source software toolkit to enable easy orchestration of edge services across diverse network platform and access technologies in multi-cloud environments. 
+
+  - title: OpenNESS OVC
+    path: /doc/applications/openness_ovc
+    meta_title: Open Visual Cloud Smart City Application on OpenNESS
+    meta_description: The Open Visual Cloud is an open source project that offers a set of pre-defined reference pipelines for various target visual cloud use cases.
+
+  - title: OpenNESS OpenVINO
+    path: /doc/applications/openness_openvino
+    meta_title: OpenVINO Sample Application in OpenNESS
+    meta_description: OpenVINO toolkit, short for Open Visual Inference and Neural network Optimization toolkit, provides improved neural network performance on Intel processors. 
+

_data/navbars/enhanced-platform-awareness.yml

@@ -0,0 +1,63 @@
+title: "Enhanced Platform Awareness"
+path: /enhanced-platform-awareness/
+order: 5
+section:
+      - title: OpenNESS Hugepage
+        path: /doc/enhanced-platform-awareness/openness-hugepage
+        meta_title: OpenNESS Enhanced Platform Awareness - Hugepage Support on OpenNESS
+        meta_description: Huge page support openness, added to Kubernetes v1.8, enables the discovery, scheduling, and allocation of huge pages as a native first-class resource.
+
+      - title: OpenNESS Node Feature Discovery
+        path: /doc/enhanced-platform-awareness/openness-node-feature-discovery
+        meta_title: Enhanced Platform Awareness - Node Feature Discovery Support in OpenNESS
+        meta_description: OpenNESS Node Feature Discovery is one of the Intel technologies that supports targeting of intelligent configuration and capacity consumption of platform capabilities.
+
+      - title: OpenNESS SRIOV Multiple Interfaces
+        path: /doc/enhanced-platform-awareness/openness-sriov-multiple-interfaces
+        meta_title: Enhanced Platform Awareness - Multiple Interface And PCIe SRIOV Support in OpenNESS
+        meta_description: Multiple Interface and PCIe SRIOV support in OpenNESS, OpenNESS Network Edge uses the Multus container network interface is a container network interface plugin for Kubernetes.
+
+      - title: OpenNESS Dedicated Core
+        path: /doc/enhanced-platform-awareness/openness-dedicated-core
+        meta_title: Dedicated CPU Core for Workload Support in OpenNESS - Enhanced Platform Awareness
+        meta_description: Multi-core COTS platforms are typical in any cloud or Cloudnative deployment. Parallel processing on multiple cores helps achieve better density.
+
+      - title: OpenNESS BIOS
+        path: /doc/enhanced-platform-awareness/openness-bios
+        meta_title: BIOS and Firmware Configuration on OpenNESS Platform
+        meta_description: BIOS and Firmware are the fundamental platform configurations of a typical Commercial off-the-shelf (COTS) platform. 
+
+      - title: OpenNESS FPGA
+        path: /doc/enhanced-platform-awareness/openness-fpga
+        meta_title: FPGA in OpenNESS- Programming, Resource Allocation and Configuration
+        meta_description: The FPGA Programmable acceleration card plays a key role in accelerating certain types of workloads which in-turn increases the overall compute capacity of a COTS platform.
+
+      - title: OpenNESS HDDL
+        path: /doc/enhanced-platform-awareness/openness_hddl
+        meta_title: Intel® Movidius™ Myriad™ X HDDL Solution in OpenNESS
+        meta_description: Intel® Movidius™ Myriad™ X HDDL solution integrates multiple Myriad™ X SoCs in a PCIe add-in card form factor or a module form factor to build a scalable, high capacity deep learning solution.
+
+      - title: OpenNESS Topology Manager
+        path: /doc/enhanced-platform-awareness/openness-topology-manager
+        meta_title: Topology Manager Support in OpenNESS, Resource Locality Awareness
+        meta_description: Topology Manager is a solution permitting k8s components like CPU Manager and Device Manager, to coordinate the resources allocated to a workload.
+
+      - title: OpenNESS Environment Variables
+        path: /doc/enhanced-platform-awareness/openness-environment-variables
+        meta_title: Environment Variable Support in OpenNESS
+        meta_description: Environment variables can be configured when creating a new Docker container. Once the container is running, any application located in that container can detect and use the variable.
+
+      - title: OpenNESS Tunable EXEC
+        path: /doc/enhanced-platform-awareness/openness-tunable-exec
+        meta_title: OpenNESS Tunable Exec - Overriding the Startup Command for Container
+        meta_description: This feature enables you to override the start-up command for a container, thus removing the need to rebuild it just to make this change. 
+
+      - title: OpenNESS Port Forward
+        path: /doc/enhanced-platform-awareness/openness-port-forward
+        meta_title: OpenNESS Port Forward  - Setting Up Port Forwarding of Container
+        meta_description: This feature enables the user to set up external network ports for their application (container) so that applications running on other hosts can connect.
+
+      - title: OpenNESS Shared Storage
+        path: /doc/enhanced-platform-awareness/openness-shared-storage
+        meta_title: Shared Storage for Containers in Openness On-Prem Mode
+        meta_description: OpenNESS On-Prem mode provides possibility to use volume and bind mount storage models known from docker.

_data/navbars/getting-started.yml

@@ -0,0 +1,40 @@
+title: "Getting Started"
+path: /getting-started/
+order: 1
+section:
+  - title: OpenNESS Experience Kits
+    path: /doc/getting-started/openness-experience-kits
+    meta_title: OpenNESS Experience Kits Easy Setup of OpenNESS in Network Edge
+    meta_description: OpenNESS Experience Kits repository contains easy setup of OpenNESS in Network Edge, On-Premises modes, and playbooks deployment of the offline package.
+
+  - title: Network Edge
+    path: 
+    section:
+    - title: Controller Edge Node Setup
+      path: /doc/getting-started/network-edge/controller-edge-node-setup
+      meta_title: OpenNESS Network Edge - Controller and Edge Node Setup
+      meta_description: OpenNESS Network Edge Controller and Edge nodes must be set up on different machines and provided in the inventory may reboot during the installation.
+
+    - title: Supported EPA
+      path: /doc/getting-started/network-edge/supported-epa
+      meta_title: OpenNESS Network Edge - Enhanced Platform Awareness Features Supported
+      meta_description: Enhanced Platform Awareness features supported for network edge is to expose capability to edge cloud orchestrator for better performance, consistency, and reliability.
+
+  - title: OnPremises
+    path: 
+    section:
+    - title: Controller Edge Node Setup
+      path: /doc/getting-started/on-premises/controller-edge-node-setup
+      meta_title: OpenNESS OnPremises - Controller and Edge Node Setup
+      meta_description: OpenNESS Controller and Edge Node to work together the Edge Node needs to enroll with the Controller until it is serial key recognized by the Controller.
+
+    - title: OpenNESS Gateway
+      path: /doc/getting-started/on-premises/openness-gateway
+      meta_title: OpenNESS Gateway Feature - Supported Mode of Operation
+      meta_description: OpenNESS gateway features to the supported mode of operation in this case still, the only requirement being the controller is on a publicly accessible network.
+
+    - title: Supported EPA
+      path: /doc/getting-started/on-premises/supported-epa
+      meta_title: OpenNESS OnPremises - Enhanced Platform Awareness Features Supported
+      meta_description: Enhanced Platform Awareness features are supported in OpenNESS OnPremises Edge using EVA APIs. OpenNESS controller UI user would use create the HTTP REST POST API.
+

_data/navbars/introduction.yml

@@ -0,0 +1,9 @@
+title: "Introduction"
+path: /architecture/
+order: 0
+section:
+- title: Architecture
+  path: /doc/architecture
+  meta_title: OpenNESS Architecture And Solution Overview
+  meta_description: OpenNESS is an open source software to enable easy orchestration of edge services and network functions across diverse network platform in multi-cloud environments.
+

_data/navbars/radio-access-network.yml

@@ -0,0 +1,8 @@
+title: "Radio Access Network (RAN)"
+path: /ran/
+order: 3
+section:
+  - title: OpenNESS RAN
+    path: /doc/ran/openness_ran
+    meta_title: OpenNESS Radio Access Network is the Edge of Wireless Network
+    meta_description: OpenNESS Radio Access Network is the edge of the wireless network. OpenNESS Intel FlexRAN uses as a reference 4G and 5G base station for 4G and 5G end-to-end testing.

_data/navbars/release-history.yml

@@ -0,0 +1,9 @@
+title: "Release history"
+path: /openness_releasenotes/
+order: 9
+section:
+- title: OpenNESS Release Notes
+  path: /openness_releasenotes
+  meta_title: OpenNESS Release Notes
+  meta_description: OpenNESS Release Notes provides high level system features, issues, and limitations information for OpenNESS.
+

_includes/breadcrumbs.html

@@ -0,0 +1,10 @@
+{%- assign pagePath = page.path | remove: ".md" | prepend: "/" -%}
+{%- for breadcrumb in include.section -%}
+    {%- if breadcrumb.section -%}
+        {%- include breadcrumbs.html section=breadcrumb.section -%}
+    {%- else -%}
+        {%- if pagePath == breadcrumb.path -%}
+            > {{breadcrumb.title}}
+        {%- endif -%}
+    {%- endif -%}
+{%- endfor -%}

_includes/footer.html

@@ -0,0 +1,50 @@
+<footer id="footer" style="position: static;">
+      <div class="container">
+        <div class="col-md-12">
+          <div class="footer-link">
+            <ul class="nav menu openness_footer mod-list">
+              <li class="divider"><span class="separator ">&copy; OpenNESS</span></li>
+              <li><a href="http://www.intel.com/content/www/us/en/legal/terms-of-use.html" rel="noopener noreferrer nofollow" target="_blank">Terms of Use</a></li>
+              <li><a href="https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html" rel="noopener noreferrer nofollow" target="_blank">Privacy</a></li>
+              <li><a href="http://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html" rel="noopener noreferrer nofollow" target="_blank">Cookies</a></li>
+              <li><a href="https://www.openness.org/contact-us">Contact Us</a></li>
+            </ul>
+          </div>
+        </div>
+      </div>
+    </footer>
+
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
+    <script src="https://kit.fontawesome.com/23e98bc57b.js" crossorigin="anonymous"></script>
+    <script src="{{ '/js/custom.js' | prepend: site.baseurl | prepend: site.siteurl  }}?{{ site.time | date: '%s%N' }}" defer></script>
+
+    <script>
+    jQuery(document).ready(function(){  
+            jQuery('.rightSection .contentArea img').each(function(e){
+            var alt = jQuery(this).attr('alt');
+           /* var imageSrc = jQuery(this).attr('src');
+            var imagePath = '{{site.siteurl}}'+imageSrc;
+            jQuery(this).attr('src',imagePath); */
+            if(alt == ''){
+                var imgName = jQuery(this).attr('src');
+                if(typeof imgName != 'undefined' && imgName != ''){
+                    var last = imgName.substring(imgName.lastIndexOf("/") + 1, imgName.length);
+                    var rest = last.substring(0, last.lastIndexOf(".") + 0);
+                    var createAlt = rest.replace(/\_/g, ' ');
+                    var a = camelize(createAlt);
+                    if(typeof a != 'undefined'){
+                        jQuery(this).attr('alt',a);
+                    }
+                }
+            } 
+        });
+    });
+
+        function camelize(str) {
+            return str.replace(/(?:^\w|[A-Z]|\b\w)/g, function(word, index) {
+              return word.toUpperCase();
+            }).replace(/\s+/g, ' ');
+        }
+
+    </script>
+