wip docs edits

Author: paigecalvert

docs/vendor/compatibility-matrix-usage.md

@@ -1,84 +1,58 @@
-# Compatibility Matrix Usage
+# Viewing Compatibility Matrix Usage History
 This topic describes using the Replicated Vendor Portal to understand
 Compatibility Matrix usage across your team.
 
-## Currently Active Clusters and Virtual Machines
-You can find current active clusters and virtual machines (VMs) on the Compatibility
-Matrix overview page which is accessible by clicking the **Compatibility Matrix**
-tab and then selecting **Overview** from the sidebar.
-
-![Compatibility Matrix Overview Page](/images/compatibility-matrix-overview.png)
-
-For more information on the Cluster and VM statuses displayed on this page
-see [Cluster Status](/vendor/testing-about#cluster-status).
-
-## Historical Usage
-The Vendor Portal offers a Compatibility Matrix history page that provides
-historical information about both clusters and virtual machines.
-
-You can access the Compatibility Matrix history page by clicking the
-**Compatibility Matrix** tab and then selecting **History** from the sidebar.
-
-Only terminated clusters and VMs are displayed on the history page.  Terminated
-is defined as a cluster or VM that has been deleted or errored.
+## View Historical Usage
+The **Compatibility Matrix > History** page provides
+historical information about both clusters and VMs, as shown below: 
 
 ![Compatibility Matrix History Page](/images/compatibility-matrix-history.png)
+[View a larger version of this image](/images/compatibility-matrix-history.png)
+
+Only _terminated_ clusters and VMs that have been deleted or errored are displayed on the **History** page.
 
-The top of the page displays the total number of terminated clusters and VMs
+The top of the **History** page displays the total number of terminated clusters and VMs
 in the selected time period as well as the total cost and usage time for
 the terminated resources.
 
-The table below includes cluster and VM entries with the following columns:
+The table includes cluster and VM entries with the following columns:
 - **Name:** The name of the cluster or VM.
 - **By:** The actor that created the resource.
-- **Cost:** The cost of the resource, this is calculated at termination and is
+- **Cost:** The cost of the resource. This is calculated at termination and is
     based on the time the resource was running.
-- **Distribution:** The distribution and version of the resource, for example
+- **Distribution:** The distribution and version of the resource. For example,
     `kind 1.32.1`.
-- **Type:** The distribution type of the resource.  Kubernetes clusters
+- **Type:** The distribution type of the resource. Kubernetes clusters
     are listed as `kubernetes` and VMs are listed as `vm`.
-- **Status:** The status of the resource, for example `terminated` or `error`.
-- **Instance:** The instance type of the resource, for example `r1.small`.
-- **Nodes:** The node count for "kubernetes" resources, VMs do not use this
+- **Status:** The status of the resource. For example `terminated` or `error`.
+- **Instance:** The instance type of the resource. For example `r1.small`.
+- **Nodes:** The node count for "kubernetes" resources. VMs do not use this
   field.
-- **Node Groups:** The node group count for "kubernetes" resources, VMs do not
+- **Node Groups:** The node group count for "kubernetes" resources. VMs do not
   use this field.
 - **Created At:** The time the resource was created.
-- **Running At:** The time the resource started running.  For billing purposes,
+- **Running At:** The time the resource started running. For billing purposes,
   this is the time when Replicated began charging for the resource.
-- **Terminated At:** The time the resource was terminated.  For billing
+- **Terminated At:** The time the resource was terminated. For billing
   purposes, this is the time when Replicated stopped charging for the resource.
-- **TTL:** The time-to-live for the resource, this is the maximum amount of
+- **TTL:** The time-to-live for the resource. This is the maximum amount of
   time the resource can run before it is automatically terminated.
-- **Duration:** The total time the resource was running, this is the time
+- **Duration:** The total time the resource was running. This is the time
   between the `running` and `terminated` states.
 - **Tag:** Any tags that were applied to the resource.
 
-Each of these fields can be filtered and sorted to help you find the information
-you are looking for.  To sort by a specific field, click on the column header.
-The column will display an up or down arrow to denote that the column is being
-sorted and the direction of the sort:
+## Filter and Sort Usage History
 
-![Compatibility Matrix History Page, column header clicked](/images/compatibility-matrix-column-sort.png)
+Each of the fields on the **History** page can be filtered and sorted. To sort by a specific field, click on the column header.
 
-To filter by a specific field, click on the filter icon in the column header:
-
-![Compatibility Matrix History Page, filter icon clicked](/images/compatibility-matrix-column-filter.png)
-
-Then use each specific filter input to filter the results:
+To filter by a specific field, click on the filter icon in the column header, then use each specific filter input to filter the results, as shown below:
 
 ![Compatibility Matrix History Page, filter input](/images/compatibility-matrix-column-filter-input.png)
+[View a larger version of this image](/images/compatibility-matrix-column-filter-input.png)
 
+## Get Usage History with the Vendor API v3
 
-## Using the Vendor API v3
-You also use the [Vendor API v3](/vendor/vendor-api-using)
-to obtain Compatibility Matrix usage information.
-
-To perform queries against the Vendor API v3, you must have a valid API token,
-see [Generating API Tokens](/vendor/replicated-api-tokens).
-
-Just like the Vendor Portal, historical and running Compatibility Matrix usage
-is divided into distinct endpoints.
+For more information about using the Vendor API v3 to get Compatibility Matrix usage history information, see [/v3/cmx/history](https://replicated-vendor-api.readme.io/reference/listcmxhistory) and [/v3/cmx/getcmxstats](https://replicated-vendor-api.readme.io/reference/getcmxstats) in the Vendor API v3 documentation.
 
 ### Credit Balance and Summarized Usage
 To obtain summarized usage information in addition to your Compatibility Matrix
@@ -255,6 +229,4 @@ curl --request GET \
 If any filter is passed for an object that does not exist, no warning is given.
 For example, if you filter by `actor-filter=name` and there are no results
 the response will be empty.
-:::
-
-
+:::

sidebars.js

@@ -208,7 +208,6 @@ const sidebars = {
               'vendor/instance-notifications-config',
               'vendor/custom-metrics',
               'vendor/instance-data-export',
-              'vendor/compatibility-matrix-usage',
             ],
         },
       ],
@@ -221,6 +220,7 @@ const sidebars = {
         'vendor/testing-pricing',
         'vendor/testing-supported-clusters',
         'vendor/testing-cluster-addons',
+        'vendor/compatibility-matrix-usage',
         'vendor/testing-how-to',
         'vendor/testing-ingress',
       ],