X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=f99a04dce9bac55e9edbfd2734a59ad71609f652;hb=761f2ad4329fcb8ef86797997f2a8b5fe5368e70;hp=459360eb3faf73fc6dcd2bd560470dd7ec509ac3;hpb=448fac1c4e8444418f9674585ecf958bc6c98df5;p=portal%2Fric-dashboard.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 459360eb..f99a04dc 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,7 +1,7 @@ .. ===============LICENSE_START======================================================= .. O-RAN SC CC-BY-4.0 .. %% -.. Copyright (C) 2019 AT&T Intellectual Property and Nokia +.. Copyright (C) 2019 AT&T Intellectual Property .. %% .. Licensed under the Apache License, Version 2.0 (the "License"); .. you may not use this file except in compliance with the License. @@ -19,7 +19,8 @@ RIC Dashboard Developer Guide ============================= -This document provides a quickstart for developers of the O-RAN SC RIC Dashboard web application. +This document provides a quickstart for developers of the O-RAN SC RIC Dashboard web +application. Prerequisites ------------- @@ -27,7 +28,20 @@ Prerequisites 1. Java development kit (JDK), version 11 or later 2. Maven dependency-management tool, version 3.4 or later -Other tools including the Node Package Manager (npm) are fetched dynamically. +Other required tools including the Node Package Manager (npm) are fetched dynamically. + +Clone and Update Submodules +--------------------------- + +After cloning the repository, initialize and update all git submodules like this:: + + git submodule init + git submodule update + +Check the submodule status at any time like this:: + + git submodule status + Angular Front-End Application ----------------------------- @@ -82,7 +96,8 @@ Production user authentication The server uses the ONAP Portal's "EPSDK-FW" library to support a single-sign-on (SSO) feature, which requires users to authenticate -at the ONAP Portal UI. +at the ONAP Portal UI. The RIC Dashboard can be on-boarded as an +application on the ONAP Portal using its application on-boarding UI. The server authenticates requests using cookies that are set by the ONAP Portal::