Merge branch 'improvement/2149-documentation-access-from-the-UI' into…

… q/2.4
scality · Jan 17, 2020 · 1ac6677 · 1ac6677
2 parents b322516 + 5d51fd9
commit 1ac6677
Show file tree

Hide file tree

Showing 10 changed files with 336 additions and 273 deletions.
diff --git a/salt/metalk8s/addons/ui/deployed/ui.sls b/salt/metalk8s/addons/ui/deployed/ui.sls
@@ -39,7 +39,8 @@ Create metalk8s-ui ConfigMap:
               "url": "/api/kubernetes",
               "url_salt": "/api/salt",
               "url_prometheus": "/api/prometheus",
-              "url_grafana": "/grafana"
+              "url_grafana": "/grafana",
+              "url_doc": "/docs"
             }
 
 Create ui-branding ConfigMap:

diff --git a/ui/cypress/integration/AccessDocumentation.feature b/ui/cypress/integration/AccessDocumentation.feature
@@ -0,0 +1,4 @@
+Feature: AccessDocumentation
+ Scenario: Access documentation from the Navbar
+     Given I log in
+     Then I can access the documentation from the navbar
diff --git a/ui/cypress/integration/common/accessDocumentation.js b/ui/cypress/integration/common/accessDocumentation.js
@@ -0,0 +1,21 @@
+import { Then } from 'cypress-cucumber-preprocessor/steps';
+
+Then('I can access the documentation from the navbar', () => {
+  const target_url = Cypress.env('target_url');
+
+  cy.visit(target_url, {
+    onBeforeLoad(win) {
+      // win is the the remote page's window object
+      // `cy.stub()` stubs the window.open method
+      cy.stub(win, 'open', url => {
+        expect(url).to.have.string('/docs/index.html');
+      });
+    },
+  });
+
+  cy.get('.sc-dropdown')
+    .eq(1)
+    .click();
+
+  cy.get('[data-cy = documentation]').click();
+});
diff --git a/ui/public/config.json b/ui/public/config.json
@@ -2,5 +2,6 @@
     "url": "https://{ip}:8443/api/kubernetes",
     "url_salt": "https://{ip}:8443/api/salt",
     "url_prometheus": "https://{ip}:8443/api/prometheus",
-    "url_grafana": "https://{ip}:8443/grafana"
+    "url_grafana": "https://{ip}:8443/grafana",
+    "url_doc": "https://{ip}:8443/docs"
 }
diff --git a/ui/src/containers/ClusterMonitoring.js b/ui/src/containers/ClusterMonitoring.js
@@ -89,7 +89,7 @@ const ClusterStatusValue = styled.span`
   }};
 `;
 
-const QuestionMarkIcon = styled.i`
+const InformationMarkIcon = styled.i`
   color: ${props => props.theme.brand.primary};
 `;
 
@@ -222,7 +222,7 @@ const ClusterMonitoring = props => {
               </TooltipContent>
             }
           >
-            <QuestionMarkIcon className="fas fa-question-circle" />
+            <InformationMarkIcon className="fas fa-info-circle" />
           </Tooltip>
           {clusterStatus.isLoading ? <LoaderCoreUI size="small" /> : null}
         </LeftClusterStatusContainer>