Update version details in README
[portal/ric-dashboard.git] / docs / developer-guide.rst
index f99a04d..e781294 100644 (file)
@@ -1,20 +1,6 @@
-.. ===============LICENSE_START=======================================================
-.. O-RAN SC CC-BY-4.0
-.. %%
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
 .. 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.
-.. You may obtain a copy of the License at
-..
-..      http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-.. ===============LICENSE_END=========================================================
 
 RIC Dashboard Developer Guide
 =============================
@@ -37,7 +23,7 @@ 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
@@ -70,11 +56,13 @@ requests at this URL:
 The directory ``src/test/resources`` contains usable versions of the required property
 files.  These steps are required to launch:
 
-1. Set an environment variable via JVM argument: ``-Dorg.oransc.ric.portal.dashboard=mock``
-2. Run the JUnit test case ``DashboardServerTest`` which is not exactly a "test" because it never finishes.
+1. Install all project jar files locally
+2. Set an environment variable via JVM argument: ``-Dorg.oransc.ric.portal.dashboard=mock``
+3. Run the JUnit test case ``DashboardTestServer`` which is not exactly a "test" because it never finishes.
 
-Both steps can be done with this command-line invocation::
+These steps can be done with these commands::
 
+     mvn -Ddocker.skip=true -DskipTests=true install
      mvn -Dorg.oransc.ric.portal.dashboard=mock -Dtest=DashboardTestServer test
 
 Development user authentication
@@ -96,7 +84,7 @@ 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. The RIC Dashboard can be on-boarded as an 
+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