Skip to content

Commit 9cb63db

Browse files
authored
(DOCSP-43886) [OM] Backport DOCSP-43014 to v7.0 (#381) (#399)
## Unnesting components in 11 OM pages. [This spreadsheet](https://docs.google.com/spreadsheets/d/1M2IlsyV0-6mY-AvBBrX-4uSDtQrbt9zuoXsqIJaVqlk/edit?gid=0#gid=0) tracks the number of nested components on each page, and [this doc](https://docs.google.com/document/d/1yMbng-EPOQ82bAzBTC2VJwIvsUBOSCJh21cGbDoe1a8/edit#heading=h.7hxlffls9cx6) provides guidelines for fixing nested components. ## [DOCSP-43014](https://jira.mongodb.org/browse/DOCSP-43014) ## STAGING 1. [ops-manager/current/reference/api/events/get-all-events-global/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/events/get-all-events-global/) — Unnested 1 example in table, and reworked example for style guide. 2. [ops-manager/current/reference/api/events/get-one-event-global/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/events/get-one-event-global/) — Unnested 1 example in table, same commit include as in Get All Events Global. 3. [ops-manager/current/reference/api/global-alert-configuration-get-all-open-alerts-triggered/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/global-alert-configuration-get-all-open-alerts-triggered/) — Unnested 1 example in table, same commit as above. 4. [ops-manager/current/reference/api/global-alert-configurations-create-one/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/global-alert-configurations-create-one/) — Unnested 2 notes in tables and deleted a redundant extra ``metricThreshold.units`` table entry. Note: could not find the 7 admonitions in tables reported in the spreadsheet. 5. [ops-manager/current/reference/api/global-alert-configurations-get-all/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/global-alert-configurations-get-all/) — Unnested 1 example in table in previous commit. Note: Could not find the 6 admonitions in tables reported in the spreadsheet. 6. [ops-manager/current/reference/api/global-alert-configurations-get-one/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/global-alert-configurations-get-one/) — Unnested 1 example in table in previous commit. Note: Could not find the 6 admonitions in tables reported in the spreadsheet. 7. [ops-manager/current/reference/api/global-alert-configurations-toggle-one/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/global-alert-configurations-toggle-one/) — Unnested 1 example in table in previous commit. Note: Could not find the 6 admonitions in tables reported in the spreadsheet. 8. [ops-manager/current/reference/api/global-alert-configurations-update-one/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/global-alert-configurations-update-one/) — Unnested 2 examples in tables in previous commit. Note: Could not find the 7 admonitions in tables reported in the spreadsheet. 9. [ops-manager/current/reference/api/global-alerts-ack-one/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/global-alerts-ack-one/)— Unnested 1 example in table in previous commit. 10. [ops-manager/current/reference/api/global-alerts-get-all/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/global-alerts-get-all/) — Unnested 1 example in table in previous commit. 11. [ops-manager/current/reference/api/global-alerts-get-one/](https://deploy-preview-381--10gen-docs-ops-manager.netlify.app/reference/api/global-alerts-get-one/) — Unnested 1 example in previous commit. ## [LATEST BUILD LOG](https://app.netlify.com/sites/10gen-docs-ops-manager/deploys/66f45494db00a83d5e5a3f18) ## Self-Review Checklist - [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [ ] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [x] Resolve any new warnings or errors in the build. - [x] Proofread for spelling and grammatical errors. - [x] Check staging for rendering issues. - [x] Confirm links are working. --------- Backport [DOCSP-43014](https://jira.mongodb.org/browse/DOCSP-43014) to v7.0 - [DOCSP-43886](https://jira.mongodb.org/browse/DOCSP-43886) - [LATEST BUILD LOG](https://app.netlify.com/sites/10gen-docs-ops-manager/deploys/66f5685d4b16f5000813c006) ### Self-Review Checklist - [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [ ] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [x] Resolve any new warnings or errors in the build. - [x] Proofread for spelling and grammatical errors. - [x] Check staging for rendering issues. - [x] Confirm links are working.
1 parent d9cf59a commit 9cb63db

File tree

4 files changed

+21
-40
lines changed

4 files changed

+21
-40
lines changed

source/includes/api/list-tables/events/responses/global-onprem.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,15 @@
5454
* - | currentValue
5555
| .units
5656
- string
57-
- Relevant units for the value.
58-
59-
.. example::
60-
61-
A metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit.
57+
- Units for ``currentValue.number``. The units depend on the type of metric.
6258

6359
Accepted values are:
6460

6561
.. include:: /includes/possibleValues-api-units.rst
6662

63+
For example, a metric that measures memory consumption can use ``BYTES``,
64+
while a metric that measures time can use ``HOURS``.
65+
6766
* - database
6867
- string
6968
- Name of the database on which the event occurred. This field

source/includes/api/list-tables/global-alert-configuration-request-body.rst

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -122,13 +122,16 @@
122122
| ``.units``
123123
- string
124124
- Conditional
125-
- Units for ``metricThreshold.threshold``. The value depends on
126-
the type of metric. For example, a metric that measures memory
127-
consumption has a byte measurement, while a metric that
128-
measures time has a time unit. Accepted values are:
125+
- Units for ``metricThreshold.threshold``. The units depend on
126+
the type of metric.
127+
128+
Accepted values are:
129129

130130
.. include:: /includes/possibleValues-api-units.rst
131131

132+
For example, a metric that measures memory consumption can use ``BYTES``,
133+
while a metric that measures time can use ``HOURS``.
134+
132135
* - ``notifications``
133136
- array of objects
134137
- Required
@@ -294,22 +297,6 @@
294297
- Threshold value outside of which this alert configuration
295298
triggers an alert.
296299

297-
* - ``metricThreshold.units``
298-
- string
299-
- Conditional
300-
- Units for ``metricThreshold.threshold``. The value depends on
301-
the type of metric.
302-
303-
.. example::
304-
305-
A metric that measures memory consumption has a byte
306-
measurement, while a metric that measures time has a time
307-
unit.
308-
309-
Accepted values are:
310-
311-
.. include:: /includes/possibleValues-api-units.rst
312-
313300
* - ``tags``
314301
- array of strings
315302
- Optional

source/includes/api/list-tables/global-alert-configuration-response.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -107,19 +107,16 @@
107107

108108
* - ``metricThreshold.units``
109109
- string
110-
- Units for ``metricThreshold.threshold``. The value depends on
110+
- Units for ``metricThreshold.threshold``. The units depend on
111111
the type of metric.
112112

113-
.. example::
114-
115-
A metric that measures memory consumption has a byte
116-
measurement, while a metric that measures time has a time
117-
unit.
118-
119-
Possible values are:
113+
Accepted values are:
120114

121115
.. include:: /includes/possibleValues-api-units.rst
122116

117+
For example, a metric that measures memory consumption can use ``BYTES``,
118+
while a metric that measures time can use ``HOURS``.
119+
123120
* - ``notifications``
124121
- array of objects
125122
- Notifications |mms| sends when it detects an alert that this

source/includes/api/list-tables/global-alert-response.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,15 @@
6161

6262
* - ``currentValue.units``
6363
- string
64-
- Units in which this value is expressed. Depends on the type of metric.
64+
- Units for ``currentValue.number``. The units depend on the type of metric.
6565

66-
.. example::
67-
68-
- A metric that measures memory consumption would have a byte measurement
69-
- A metric that measures time would have a time unit.
70-
71-
Possible values that can be returned include:
66+
Accepted values are:
7267

7368
.. include:: /includes/possibleValues-api-units.rst
7469

70+
For example, a metric that measures memory consumption can use ``BYTES``,
71+
while a metric that measures time can use ``HOURS``.
72+
7573
* - ``eventTypeName``
7674
- string
7775
- Name of the event that triggered the alert.

0 commit comments

Comments
 (0)