From ae0cc29b331339ed86cb7b007addf21d8fdbf077 Mon Sep 17 00:00:00 2001
From: James Taylor <jt-nti@users.noreply.github.com>
Date: Thu, 30 Nov 2017 13:50:38 +0000
Subject: [PATCH] Add legal link to configuration data (#2890)

Also includes improvement to doc website navigation

Contributes to #2882

Signed-off-by: James Taylor <jamest@uk.ibm.com>
---
 .../src/app/footer/footer.component.html       |  4 ++--
 .../src/app/footer/footer.component.spec.ts    | 12 ++++++++----
 .../src/app/services/config.service.spec.ts    |  3 ++-
 .../config/configStructure.service.spec.ts     | 18 ++++++++++++------
 .../services/config/configStructure.service.ts |  6 ++++--
 .../_includes/sidebars/accordion-toc0.md       |  4 ++--
 6 files changed, 30 insertions(+), 17 deletions(-)

diff --git a/packages/composer-playground/src/app/footer/footer.component.html b/packages/composer-playground/src/app/footer/footer.component.html
index 259d0ff87d..5dc62f93d0 100644
--- a/packages/composer-playground/src/app/footer/footer.component.html
+++ b/packages/composer-playground/src/app/footer/footer.component.html
@@ -1,7 +1,7 @@
 <div class="footer-main">
     <div class="footer-left">
-        <div class="footer-item">
-            <a href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank">Legal</a>
+        <div *ngIf='config.links.legal.trim() !== ""' class="footer-item">
+            <a href="{{ config.links.legal }}" target="_blank">Legal</a>
         </div>
         <div *ngIf='config.links.github.trim() !== ""' class="footer-item">
             <a href="{{ config.links.github }}" target="_blank">GitHub</a>
diff --git a/packages/composer-playground/src/app/footer/footer.component.spec.ts b/packages/composer-playground/src/app/footer/footer.component.spec.ts
index 82c42995e9..9e0d4f5885 100644
--- a/packages/composer-playground/src/app/footer/footer.component.spec.ts
+++ b/packages/composer-playground/src/app/footer/footer.component.spec.ts
@@ -43,7 +43,8 @@ const mockResponseConfigService = {
         tutorial: 'My Tutorial',
         community: 'My Community',
         github: 'My Github',
-        install: 'My Install'
+        install: 'My Install',
+        legal: 'My License'
     }
 };
 
@@ -89,7 +90,8 @@ describe('FooterComponent', () => {
                 tutorial: 'My Tutorial',
                 community: 'My Community',
                 github: 'My Github',
-                install: 'My Install'
+                install: 'My Install',
+                legal: 'My License'
             };
 
             configService['configLoaded'] = true;
@@ -132,7 +134,8 @@ describe('FooterComponent', () => {
                 tutorial: 'My Tutorial',
                 community: 'My Community',
                 github: 'My Github',
-                install: 'My Install'
+                install: 'My Install',
+                legal: 'My License'
             };
 
             mockBackend.connections.subscribe((connection) => {
@@ -158,7 +161,8 @@ describe('FooterComponent', () => {
                 tutorial: 'My Tutorial',
                 community: 'My Community',
                 github: 'My Github',
-                install: 'My Install'
+                install: 'My Install',
+                legal: 'My License'
             };
 
             configService['configLoaded'] = true;
diff --git a/packages/composer-playground/src/app/services/config.service.spec.ts b/packages/composer-playground/src/app/services/config.service.spec.ts
index f660453850..d153b398dd 100644
--- a/packages/composer-playground/src/app/services/config.service.spec.ts
+++ b/packages/composer-playground/src/app/services/config.service.spec.ts
@@ -46,7 +46,8 @@ describe('ConfigService', () => {
               tutorial: 'My Tutorial',
               community: 'My Community',
               github: 'My Github',
-              install: 'My Install'
+              install: 'My Install',
+              legal: 'My License'
             };
 
             // setup a mocked response
diff --git a/packages/composer-playground/src/app/services/config/configStructure.service.spec.ts b/packages/composer-playground/src/app/services/config/configStructure.service.spec.ts
index ed5cd419e2..a2e04fe1db 100644
--- a/packages/composer-playground/src/app/services/config/configStructure.service.spec.ts
+++ b/packages/composer-playground/src/app/services/config/configStructure.service.spec.ts
@@ -23,7 +23,8 @@ describe('Config', () => {
                 tutorial: 'My Tutorial',
                 community: 'My Community',
                 github: 'My Github',
-                install: 'My Install'
+                install: 'My Install',
+                legal: 'My License'
               },
               analyticsID: 'My ID'
           };
@@ -38,7 +39,8 @@ describe('Config', () => {
                                             tutorial: 'My Tutorial',
                                             community: 'My Community',
                                             github: 'My Github',
-                                            install: 'My Install'
+                                            install: 'My Install',
+                                            legal: 'My License'
                                           });
           service.analyticsID.should.deep.equal('My ID');
       });
@@ -65,7 +67,8 @@ describe('Config', () => {
                               tutorial: 'https://hyperledger.github.io/composer/tutorials/playground-tutorial.html',
                               community: 'https://hyperledger.github.io/composer/support/support-index.html',
                               github: 'https://github.com/hyperledger/composer',
-                              install: 'https://hyperledger.github.io/composer/installing/installing-index.html'
+                              install: 'https://hyperledger.github.io/composer/installing/installing-index.html',
+                              legal: 'https://www.apache.org/licenses/LICENSE-2.0'
                           };
 
           service.setValuesFromObject(object);
@@ -75,7 +78,8 @@ describe('Config', () => {
                                               tutorial: 'https://hyperledger.github.io/composer/tutorials/playground-tutorial.html',
                                               community: 'https://hyperledger.github.io/composer/support/support-index.html',
                                               github: 'https://github.com/hyperledger/composer',
-                                              install: 'https://hyperledger.github.io/composer/installing/installing-index.html'
+                                              install: 'https://hyperledger.github.io/composer/installing/installing-index.html',
+                                              legal: 'https://www.apache.org/licenses/LICENSE-2.0'
                                           });
       });
   });
@@ -90,7 +94,8 @@ describe('Config', () => {
           tutorial: 'My Tutorial',
           community: 'My Community',
           github: 'My Github',
-          install: 'My Install'
+          install: 'My Install',
+          legal: 'My License'
         };
         service.analyticsID = 'My ID';
 
@@ -104,7 +109,8 @@ describe('Config', () => {
                                             tutorial: 'https://hyperledger.github.io/composer/tutorials/playground-tutorial.html',
                                             community: 'https://hyperledger.github.io/composer/support/support-index.html',
                                             github: 'https://github.com/hyperledger/composer',
-                                            install: 'https://hyperledger.github.io/composer/installing/installing-index.html'
+                                            install: 'https://hyperledger.github.io/composer/installing/installing-index.html',
+                                            legal: 'https://www.apache.org/licenses/LICENSE-2.0'
                                         });
 
         should.not.exist(service.analyticsID);
diff --git a/packages/composer-playground/src/app/services/config/configStructure.service.ts b/packages/composer-playground/src/app/services/config/configStructure.service.ts
index 97c1236bb3..8283d1db8c 100644
--- a/packages/composer-playground/src/app/services/config/configStructure.service.ts
+++ b/packages/composer-playground/src/app/services/config/configStructure.service.ts
@@ -7,7 +7,8 @@ export class Config {
     tutorial: <string> '',
     community: <string> '',
     github: <string> '',
-    install: <string> ''
+    install: <string> '',
+    legal: <string> ''
   };
   public analyticsID: string = null;
 
@@ -24,7 +25,8 @@ export class Config {
       tutorial: <string> 'https://hyperledger.github.io/composer/tutorials/playground-tutorial.html',
       community: <string> 'https://hyperledger.github.io/composer/support/support-index.html',
       github: <string> 'https://github.com/hyperledger/composer',
-      install: <string> 'https://hyperledger.github.io/composer/installing/installing-index.html'
+      install: <string> 'https://hyperledger.github.io/composer/installing/installing-index.html',
+      legal: <string> 'https://www.apache.org/licenses/LICENSE-2.0'
     };
     this.analyticsID = null;
   }
diff --git a/packages/composer-website/jekylldocs/_includes/sidebars/accordion-toc0.md b/packages/composer-website/jekylldocs/_includes/sidebars/accordion-toc0.md
index 86f4953aa8..feae646e81 100644
--- a/packages/composer-website/jekylldocs/_includes/sidebars/accordion-toc0.md
+++ b/packages/composer-website/jekylldocs/_includes/sidebars/accordion-toc0.md
@@ -3,9 +3,9 @@
 {% if page.index-order %}
 {% capture mods %}{{ page.index-order | modulo:100 }}{% endcapture %}
 {% if mods == "0" and page.exception == nil %}
-- [<b>{{ page.title }}</b><img src="{{site.baseurl}}/assets/img/Caret_SW_2.svg" class="caret">](..{{page.url}}.html)
+- [<b>{{ page.title }}</b><img src="{{site.baseurl}}/assets/img/Caret_SW_2.svg" class="caret">]({{site.baseurl}}{{page.url}})
 {% elsif mods != "0" and page.exception == nil %}
-  - [{{page.title}}](..{{page.url}}.html)
+  - [{{page.title}}]({{site.baseurl}}{{page.url}})
 {% endif %}
 {% endif %}
 {% endfor %}