docs: add instance archive and bulk archive documentation#4056
docs: add instance archive and bulk archive documentation#4056alicenstar wants to merge 3 commits into
Conversation
Adds documentation for archiving and unarchiving instances to the instance-insights-details page, and documents the bulk archive feature and show archived instances toggle on the customer-reporting page.
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| #### Show archived instances | ||
|
|
||
| Archived instances are hidden from the **Instances** section by default. To include archived instances in the list, enable the **Show Archived Instances** toggle on the **Customers > Instances** tab. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are hidden').
|
|
||
| Archived instances are hidden from the **Instances** section by default. To include archived instances in the list, enable the **Show Archived Instances** toggle on the **Customers > Instances** tab. | ||
|
|
||
| For more information about archiving and unarchiving individual instances, see [Archive and Unarchive Instances](instance-insights-details#archive-and-unarchive-instances) in _Instance Details_. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'unarchiving'?
|
|
||
| #### Bulk archive instances | ||
|
|
||
| You can archive multiple instances at once from the **Customers > Instances** tab. |
There was a problem hiding this comment.
[Replicated.WordSwaps] Use 'after' or 'one time' instead of 'once'.
| 1. Click **Archive instances**. | ||
| 1. In the confirmation dialog, click **Archive**. | ||
|
|
||
| The Vendor Portal archives all eligible instances and skips any instances that do not meet the archiving criteria (for example, active production instances). A summary shows how many instances were archived and lists any skipped instances with the reason they were skipped. You can archive up to 100 instances in a single bulk operation. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('were archived').
| 1. Click **Archive instances**. | ||
| 1. In the confirmation dialog, click **Archive**. | ||
|
|
||
| The Vendor Portal archives all eligible instances and skips any instances that do not meet the archiving criteria (for example, active production instances). A summary shows how many instances were archived and lists any skipped instances with the reason they were skipped. You can archive up to 100 instances in a single bulk operation. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('were skipped').
| * The first seven characters of the instance ID | ||
| * The instance's status. See [Enabling and Understanding Application Status](insights-app-status). | ||
| * The application version | ||
| * Details about the cluster where the instance is installed |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is installed').
| ## Archive a customer | ||
|
|
||
| When you archive a customer in the Vendor Portal, the customer is hidden from search by default and becomes read-only. Archival does not affect the utility of license files downloaded before the customer was archived. | ||
| When you archive a customer in the Vendor Portal, the customer is hidden from search by default and becomes read-only. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is hidden').
| When you archive a customer in the Vendor Portal, the customer is hidden from search by default and becomes read-only. | ||
|
|
||
| To expire a license, set an expiration date and policy in the **Expiration policy** field before you archive the customer. | ||
| Archiving a customer does not change the functionality or utility of licenses downloaded before the customer was archived. To expire a license, set an expiration date and policy in the **Expiration policy** field before you archive the customer. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('was archived').
|
|
||
| 1. From the **Instance details** page for the target instance, click **Archive instance** or **Unarchive instance**. | ||
|
|
||
| :::note |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
|
|
||
| You can archive up to 100 instances in a single bulk operation. | ||
|
|
||
| When you bulk archive, the Vendor Portal archives all eligible instances and skips any instances that do not meet the archiving criteria (for example, active production instances). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
| 1. In the confirmation dialog, click **Archive**. | ||
|
|
||
| <img alt="search box and filters on the customers page" src="/images/customers-filter.png" width="400px"/> | ||
| A summary shows how many instances were archived and lists any skipped instances with the reason they were skipped. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('were archived').
| 1. In the confirmation dialog, click **Archive**. | ||
|
|
||
| <img alt="search box and filters on the customers page" src="/images/customers-filter.png" width="400px"/> | ||
| A summary shows how many instances were archived and lists any skipped instances with the reason they were skipped. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('were skipped').
| You can also filter customers by custom ID or email address. To filter customers by custom ID or email, use the search box and prepend your search term with "customId:" (ex: `customId:1234`) or "email:" (ex: `email:bob@replicated.com`). | ||
| * On the **Customers** page, use the search box and filters to find customer records. For example, you can filter by active or inactive customer records, license type, release channel, and more. | ||
|
|
||
| To filter customers by custom ID or email, use the search box and prepend your search term with "customId:" (ex: `customId:1234`) or "email:" (ex: `email:bob@replicated.com`). |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'customId'?
| You can unarchive by clicking **Unarchive Customer** in the customer's **Manage customer** page. | ||
|
|
||
| ## Export customer and instance data {#export} | ||
| ## Manage customer instances |
There was a problem hiding this comment.
added this section to the Create and manage customers page, since we already had info about searching and filtering customers & exporting customer/instance data here
| The Vendor Portal provides insights about the health, status, and performance of the active application instances associated with each customer license on the **Instance details** page. You can use these insights to more quickly troubleshoot issues with your customers' active instances, helping to reduce support burden. | ||
|
|
||
| From the **Reporting** page for the selected customer, click the **View details** button for the desired application instance. | ||
| From the **Instance details** page, you can also archive and unarchive instances. For more information, see [Archive or unarchive an instance](/vendor/releases-creating-customer#archive-instance) in _Create and manage customers_. |
There was a problem hiding this comment.
^ added to the Instance details page with a link for more info
|
|
||
| From the **Instances** section, you can: | ||
| * Click any of the instances to open its **Instance details** page. For more information, see [Instance Details](instance-insights-details). | ||
| * Bulk archive instances. For more information, see [Bulk archive instances](/vendor/releases-creating-customers#bulk-archive-instances) in _Create and manage customers_. |
There was a problem hiding this comment.
^ added this with a link for more info
|  | ||
| [View a larger version of this image](/images/instance-row.png) | ||
|
|
||
| The **Instances** section displays the following details about each active instance: |
There was a problem hiding this comment.
all this info felt like overkill
| # Instance details | ||
|
|
||
| This topic describes using the Replicated Vendor Portal to quickly understand the recent events and performance of application instances installed in your customers' environments. | ||
| ## About the instance details page {#about-page} |
There was a problem hiding this comment.
also cut back on a lot of the info here
3 participants
Summary
This PR adds documentation for the instance archive feature, which was previously only mentioned in release notes.
Changes
docs/vendor/instance-insights-details.md: Added "Archive and unarchive instances" section covering:docs/vendor/customer-reporting.md: Added under the Instances section: