diff --git a/ui/lib/core/addon/components/replication-doc-link.js b/ui/lib/core/addon/components/replication-doc-link.js index 0f70e1332a8d..af4f814a4ab2 100644 --- a/ui/lib/core/addon/components/replication-doc-link.js +++ b/ui/lib/core/addon/components/replication-doc-link.js @@ -1,6 +1,17 @@ import Component from '@ember/component'; import layout from '../templates/components/replication-doc-link'; +/** + * @module ReplicationDocLink + * The `ReplicationDocLink` component is a learn link with helper text used on the Replication Dashboards. + * The link takes you to the key monitoring metrics learn doc. + * + * @example + * ```js + * + * ``` + */ + export default Component.extend({ layout, }); diff --git a/ui/lib/core/addon/components/replication-header.js b/ui/lib/core/addon/components/replication-header.js index 7824284f4084..1c6b4aa44c46 100644 --- a/ui/lib/core/addon/components/replication-header.js +++ b/ui/lib/core/addon/components/replication-header.js @@ -1,6 +1,25 @@ import Component from '@ember/component'; import layout from '../templates/components/replication-header'; +/** + * @module ReplicationHeader + * The `ReplicationHeader` is a header component used on the Replication Dashboards. + * + * @example + * ```js + * + * ``` + * @param {Object} model=null - An Ember data object pulled from the Ember cluster model. + * @param {String} title=null - The title of the header. + * @param {String} [secondaryID=null] - The secondaryID pulled off of the model object. + * @param {Boolean} isSummaryDashboard=false - True when you have both a primary performance and dr cluster dashboard. + */ + export default Component.extend({ layout, classNames: ['replication-header'], diff --git a/ui/lib/core/addon/components/replication-table-rows.js b/ui/lib/core/addon/components/replication-table-rows.js index 7e09b0aab50f..792c38763862 100644 --- a/ui/lib/core/addon/components/replication-table-rows.js +++ b/ui/lib/core/addon/components/replication-table-rows.js @@ -2,6 +2,21 @@ import Component from '@ember/component'; import { computed } from '@ember/object'; import layout from '../templates/components/replication-table-rows'; +/** + * @module ReplicationTableRows + * The `ReplicationTableRows` component is table component. It displays cluster mode details specific to the cluster of the Dashboard it is used on. + * + * @example + * ```js + * + * ``` + * @param {Object} replicationDetails=null - An Ember data object pulled from the Ember Model. It contains details specific to the whether the replication is dr or performance. + * @param {String} clusterMode=null - The cluster mode (e.g. primary or secondary) passed through to a table component. + */ + export default Component.extend({ layout, classNames: ['replication-table-rows'], diff --git a/ui/lib/replication/addon/components/replication-primary-card.js b/ui/lib/replication/addon/components/replication-primary-card.js index 69cb8c05b414..af475754600e 100644 --- a/ui/lib/replication/addon/components/replication-primary-card.js +++ b/ui/lib/replication/addon/components/replication-primary-card.js @@ -36,7 +36,6 @@ export default Component.extend({ return false; }), errorMessage: computed('hasError', function() { - // TODO figure out if we need another error message return this.hasError ? 'Check server logs!' : false; }), });