From 3f18b6f0b69e27272be08004747045e714d046ce Mon Sep 17 00:00:00 2001
From: Sergio Betanzos <sbetanzos@opennebula.io>
Date: Mon, 12 Jul 2021 14:37:23 +0200
Subject: [PATCH] F OpenNebula/one#5422: Add doc to client

---
 .../{icons => components/Icons}/docker.js     |  6 +++--
 .../src/client/components/Icons/index.js      | 22 +++++++++++++++++++
 .../Icons/opennebula.js}                      | 10 ++++-----
 .../client/components/LoadingScreen/index.js  |  4 ++--
 .../src/client/components/Sidebar/index.js    |  4 ++--
 .../Steps/Tiers/Steps/Template/index.js       | 10 ++++-----
 .../src/client/containers/Login/index.js      |  9 ++++++--
 .../src/client/providers/muiProvider.js       |  1 +
 .../src/client/providers/notistackProvider.js |  1 +
 src/fireedge/src/client/router/index.js       |  1 +
 src/fireedge/src/client/store/index.js        |  1 +
 src/fireedge/src/client/theme/index.js        |  1 +
 12 files changed, 52 insertions(+), 18 deletions(-)
 rename src/fireedge/src/client/{icons => components/Icons}/docker.js (94%)
 create mode 100644 src/fireedge/src/client/components/Icons/index.js
 rename src/fireedge/src/client/{icons/logo.js => components/Icons/opennebula.js} (97%)

diff --git a/src/fireedge/src/client/icons/docker.js b/src/fireedge/src/client/components/Icons/docker.js
similarity index 94%
rename from src/fireedge/src/client/icons/docker.js
rename to src/fireedge/src/client/components/Icons/docker.js
index 57ee0689d9..32f88638b0 100644
--- a/src/fireedge/src/client/icons/docker.js
+++ b/src/fireedge/src/client/components/Icons/docker.js
@@ -16,7 +16,7 @@
 import * as React from 'react'
 import { number, string, oneOfType } from 'prop-types'
 
-function DockerLogo ({ viewBox, width, height, color, ...props }) {
+const DockerLogo = React.memo(({ viewBox, width, height, color, ...props }) => {
   return (
     <svg viewBox={viewBox} width={width} height={height} {...props} {...props}>
       <path
@@ -25,7 +25,7 @@ function DockerLogo ({ viewBox, width, height, color, ...props }) {
       />
     </svg>
   )
-}
+})
 
 DockerLogo.propTypes = {
   width: oneOfType([number, string]).isRequired,
@@ -41,4 +41,6 @@ DockerLogo.defaultProps = {
   color: '#066da5'
 }
 
+DockerLogo.displayName = 'DockerLogo'
+
 export default DockerLogo
diff --git a/src/fireedge/src/client/components/Icons/index.js b/src/fireedge/src/client/components/Icons/index.js
new file mode 100644
index 0000000000..1802f1f34c
--- /dev/null
+++ b/src/fireedge/src/client/components/Icons/index.js
@@ -0,0 +1,22 @@
+/* ------------------------------------------------------------------------- *
+ * Copyright 2002-2021, OpenNebula Project, OpenNebula Systems               *
+ *                                                                           *
+ * 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.                                            *
+ * ------------------------------------------------------------------------- */
+import DockerLogo from 'client/components/Icons/docker'
+import OpenNebulaLogo from 'client/components/Icons/opennebula'
+
+export {
+  DockerLogo,
+  OpenNebulaLogo
+}
diff --git a/src/fireedge/src/client/icons/logo.js b/src/fireedge/src/client/components/Icons/opennebula.js
similarity index 97%
rename from src/fireedge/src/client/icons/logo.js
rename to src/fireedge/src/client/components/Icons/opennebula.js
index 8a5f69a517..9f22ec2f36 100644
--- a/src/fireedge/src/client/icons/logo.js
+++ b/src/fireedge/src/client/components/Icons/opennebula.js
@@ -19,7 +19,7 @@ import { useTheme } from '@material-ui/core'
 
 import { SCHEMES } from 'client/constants'
 
-const Logo = memo(({ width, height, spinner, withText, viewBox, ...props }) => {
+const OpenNebulaLogo = memo(({ width, height, spinner, withText, viewBox, ...props }) => {
   const { palette: { type } } = useTheme()
   const isDarkMode = type === SCHEMES.DARK
 
@@ -129,7 +129,7 @@ const Logo = memo(({ width, height, spinner, withText, viewBox, ...props }) => {
   )
 })
 
-Logo.propTypes = {
+OpenNebulaLogo.propTypes = {
   width: oneOfType([number, string]).isRequired,
   height: oneOfType([number, string]).isRequired,
   viewBox: string,
@@ -137,7 +137,7 @@ Logo.propTypes = {
   withText: bool
 }
 
-Logo.defaultProps = {
+OpenNebulaLogo.defaultProps = {
   width: 360,
   height: 360,
   viewBox: '0 0 425 167',
@@ -145,6 +145,6 @@ Logo.defaultProps = {
   withText: false
 }
 
-Logo.displayName = 'LogoOne'
+OpenNebulaLogo.displayName = 'OpenNebulaLogo'
 
-export default Logo
+export default OpenNebulaLogo
diff --git a/src/fireedge/src/client/components/LoadingScreen/index.js b/src/fireedge/src/client/components/LoadingScreen/index.js
index d6a3ef3e4d..984c610e71 100644
--- a/src/fireedge/src/client/components/LoadingScreen/index.js
+++ b/src/fireedge/src/client/components/LoadingScreen/index.js
@@ -16,7 +16,7 @@
 import * as React from 'react'
 
 import { makeStyles, Box } from '@material-ui/core'
-import Logo from 'client/icons/logo'
+import { OpenNebulaLogo } from 'client/components/Icons'
 
 const useStyles = makeStyles(theme => ({
   root: {
@@ -41,7 +41,7 @@ const LoadingScreen = () => {
 
   return (
     <Box className={classes.root}>
-      <Logo width={360} height={360} spinner withText />
+      <OpenNebulaLogo width={360} height={360} spinner withText />
     </Box>
   )
 }
diff --git a/src/fireedge/src/client/components/Sidebar/index.js b/src/fireedge/src/client/components/Sidebar/index.js
index d702a403ad..47fa601a58 100644
--- a/src/fireedge/src/client/components/Sidebar/index.js
+++ b/src/fireedge/src/client/components/Sidebar/index.js
@@ -32,7 +32,7 @@ import { useGeneral, useGeneralApi } from 'client/features/General'
 import sidebarStyles from 'client/components/Sidebar/styles'
 import SidebarLink from 'client/components/Sidebar/SidebarLink'
 import SidebarCollapseItem from 'client/components/Sidebar/SidebarCollapseItem'
-import Logo from 'client/icons/logo'
+import { OpenNebulaLogo } from 'client/components/Icons'
 
 const Sidebar = ({ endpoints }) => {
   const classes = sidebarStyles()
@@ -69,7 +69,7 @@ const Sidebar = ({ endpoints }) => {
       open={isFixMenu}
     >
       <Box className={classes.header}>
-        <Logo
+        <OpenNebulaLogo
           width='100%'
           height={50}
           withText
diff --git a/src/fireedge/src/client/containers/ApplicationsTemplates/Form/Create/Steps/Tiers/Steps/Template/index.js b/src/fireedge/src/client/containers/ApplicationsTemplates/Form/Create/Steps/Tiers/Steps/Template/index.js
index 59d4b3a312..3997318c50 100644
--- a/src/fireedge/src/client/containers/ApplicationsTemplates/Form/Create/Steps/Tiers/Steps/Template/index.js
+++ b/src/fireedge/src/client/containers/ApplicationsTemplates/Form/Create/Steps/Tiers/Steps/Template/index.js
@@ -22,13 +22,13 @@ import {
   SimpleCart as MarketplaceIcon,
   EmptyPage as TemplateIcon
 } from 'iconoir-react'
-import DockerLogo from 'client/icons/docker'
 
+import { DockerLogo } from 'client/components/Icons'
+import ListTemplates from 'client/containers/ApplicationsTemplates/Form/Create/Steps/Tiers/Steps/Template/List/Templates'
+import ListMarketApps from 'client/containers/ApplicationsTemplates/Form/Create/Steps/Tiers/Steps/Template/List/MarketApps'
+import DockerFile from 'client/containers/ApplicationsTemplates/Form/Create/Steps/Tiers/Steps/Template/List/Docker'
+import { STEP_FORM_SCHEMA } from 'client/containers/ApplicationsTemplates/Form/Create/Steps/Tiers/Steps/Template/schema'
 import { T } from 'client/constants'
-import ListTemplates from './List/Templates'
-import ListMarketApps from './List/MarketApps'
-import DockerFile from './List/Docker'
-import { STEP_FORM_SCHEMA } from './schema'
 
 export const STEP_ID = 'template'
 
diff --git a/src/fireedge/src/client/containers/Login/index.js b/src/fireedge/src/client/containers/Login/index.js
index 8abac0f50c..d1fe59b6e3 100644
--- a/src/fireedge/src/client/containers/Login/index.js
+++ b/src/fireedge/src/client/containers/Login/index.js
@@ -21,7 +21,7 @@ import { Paper, Box, Container, LinearProgress, useMediaQuery } from '@material-
 import { useFetch } from 'client/hooks'
 import { useAuth, useAuthApi } from 'client/features/Auth'
 
-import Logo from 'client/icons/logo'
+import { OpenNebulaLogo } from 'client/components/Icons'
 import Form from 'client/containers/Login/Form'
 import * as FORMS from 'client/containers/Login/schema'
 import loginStyles from 'client/containers/Login/styles'
@@ -79,7 +79,12 @@ function Login () {
       {isLoading && <LinearProgress color='secondary' className={classes.loading} />}
       <Paper variant="outlined" className={classes.paper}>
         {useMemo(() => (
-          <Logo width='100%' height={100} withText data-cy='opennebula-logo' />
+          <OpenNebulaLogo
+            data-cy='opennebula-logo'
+            height={100}
+            width='100%'
+            withText
+          />
         ), [])}
         <Box className={classes.wrapperForm}>
           {step === STEPS.USER_FORM && <Form
diff --git a/src/fireedge/src/client/providers/muiProvider.js b/src/fireedge/src/client/providers/muiProvider.js
index fcb26dfb24..e747136beb 100644
--- a/src/fireedge/src/client/providers/muiProvider.js
+++ b/src/fireedge/src/client/providers/muiProvider.js
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and       *
  * limitations under the License.                                            *
  * ------------------------------------------------------------------------- */
+/* eslint-disable jsdoc/require-jsdoc */
 import * as React from 'react'
 import PropTypes from 'prop-types'
 
diff --git a/src/fireedge/src/client/providers/notistackProvider.js b/src/fireedge/src/client/providers/notistackProvider.js
index 853c49b68a..8adb137b38 100644
--- a/src/fireedge/src/client/providers/notistackProvider.js
+++ b/src/fireedge/src/client/providers/notistackProvider.js
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and       *
  * limitations under the License.                                            *
  * ------------------------------------------------------------------------- */
+/* eslint-disable jsdoc/require-jsdoc */
 import * as React from 'react'
 import PropTypes from 'prop-types'
 
diff --git a/src/fireedge/src/client/router/index.js b/src/fireedge/src/client/router/index.js
index f229268f8b..b61b9abe97 100644
--- a/src/fireedge/src/client/router/index.js
+++ b/src/fireedge/src/client/router/index.js
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and       *
  * limitations under the License.                                            *
  * ------------------------------------------------------------------------- */
+/* eslint-disable jsdoc/require-jsdoc */
 import * as React from 'react'
 import PropTypes from 'prop-types'
 
diff --git a/src/fireedge/src/client/store/index.js b/src/fireedge/src/client/store/index.js
index 3ee44d753a..00723e083f 100644
--- a/src/fireedge/src/client/store/index.js
+++ b/src/fireedge/src/client/store/index.js
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and       *
  * limitations under the License.                                            *
  * ------------------------------------------------------------------------- */
+/* eslint-disable jsdoc/require-jsdoc */
 import { configureStore, getDefaultMiddleware } from '@reduxjs/toolkit'
 
 import thunkMiddleware from 'redux-thunk'
diff --git a/src/fireedge/src/client/theme/index.js b/src/fireedge/src/client/theme/index.js
index 6ea896ce1e..14075085ba 100644
--- a/src/fireedge/src/client/theme/index.js
+++ b/src/fireedge/src/client/theme/index.js
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and       *
  * limitations under the License.                                            *
  * ------------------------------------------------------------------------- */
+/* eslint-disable jsdoc/require-jsdoc */
 import {
   createMuiTheme,
   responsiveFontSizes,