forked from chocolatey/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(chocolatey#1113) Updates to button text and syntax
This updates some of the button text to the proper wording based on the incoming accessibility enhancements. This also fixes a few cases where buttons were referenced in a code block instead of in bold.
- Loading branch information
Showing
15 changed files
with
187 additions
and
187 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
66 changes: 33 additions & 33 deletions
66
...cs/en-us/central-management/usage/website/administration/settings/dashboard.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,33 @@ | ||
| --- | ||
| order: 13 | ||
| xref: ccm-administration-settings-dashboard | ||
| title: Dashboard | ||
| description: Information about setting Dashboard settings within the Administration Settings screen | ||
| --- | ||
| import Callout from '@choco/components/Callout.astro'; | ||
| import Iframe from '@choco/components/Iframe.astro'; | ||
| import Xref from '@components/Xref.astro'; | ||
|
|
||
| <Callout type="info"> | ||
| This feature is available in Chocolatey Central Management starting with version 0.12.0. | ||
| </Callout> | ||
|
|
||
| On the <Xref title="Chocolatey Central Management Dashboard" value="ccm-dashboard" /> there is a count of the `Total Stale Computers`. This is defined as `the total number of Computers that haven't reported into Chocolatey Central Management in the last 180 days.`. Here 180 is the default value, but you can change this by using the following steps: | ||
|
|
||
| 1. Open the Chocolatey Central Management Site in the browser. | ||
| 1. Login with the `ccmadmin` user. | ||
| 1. In the left-hand menu click on `Administration` and then `Settings`. | ||
| 1. Click on the `Dashboard` tab in the `Settings` screen. | ||
|
|
||
|  | ||
|
|
||
| 1. Adjust the `Amount of time, in Days, before being notified of Computers not reporting in`. | ||
| 1. Click the `Save All` button to save changes. | ||
|
|
||
| <Callout type="info"> | ||
| When the <Xref title="Stale Computer Retention Policy" value="ccm-administration-settings-retention" anchor="stale-computer-retention" /> is enabled, it is not possible to set the `Amount of time, in Days, before being notified of Computers not reporting in` for the Dashboard to a number that is lower than what is currently configured for the `Amount of time, in Days, to keep stale Computers before deleting` setting, and vice versa. If this is attempted, a validation warning will be shown. | ||
| </Callout> | ||
|
|
||
| <Callout type="info"> | ||
| When upgrading to Chocolatey Central Management 0.12.0, if the <Xref title="Stale Computer Retention Policy" value="ccm-administration-settings-retention" anchor="stale-computer-retention" /> is enabled, if the current value for `Amount of time, in Days, to keep stale Computers before deleting` is less than the default value for `Amount of time, in Days, before being notified of Computers not reporting in`, a change will be made to the default value to make it half of the configured value for `Amount of time, in Days, to keep stale Computers before deleting`. | ||
| </Callout> | ||
| --- | ||
| order: 13 | ||
| xref: ccm-administration-settings-dashboard | ||
| title: Dashboard | ||
| description: Information about setting Dashboard settings within the Administration Settings screen | ||
| --- | ||
| import Callout from '@choco/components/Callout.astro'; | ||
| import Iframe from '@choco/components/Iframe.astro'; | ||
| import Xref from '@components/Xref.astro'; | ||
|
|
||
| <Callout type="info"> | ||
| This feature is available in Chocolatey Central Management starting with version 0.12.0. | ||
| </Callout> | ||
|
|
||
| On the <Xref title="Chocolatey Central Management Dashboard" value="ccm-dashboard" /> there is a count of the `Total Stale Computers`. This is defined as `the total number of Computers that haven't reported into Chocolatey Central Management in the last 180 days.`. Here 180 is the default value, but you can change this by using the following steps: | ||
|
|
||
| 1. Open the Chocolatey Central Management Site in the browser. | ||
| 1. Login with the `ccmadmin` user. | ||
| 1. In the left-hand menu click on `Administration` and then `Settings`. | ||
| 1. Click on the `Dashboard` tab in the `Settings` screen. | ||
|
|
||
|  | ||
|
|
||
| 1. Adjust the `Amount of time, in Days, before being notified of Computers not reporting in`. | ||
| 1. Click the **Save All** button to save changes. | ||
|
|
||
| <Callout type="info"> | ||
| When the <Xref title="Stale Computer Retention Policy" value="ccm-administration-settings-retention" anchor="stale-computer-retention" /> is enabled, it is not possible to set the `Amount of time, in Days, before being notified of Computers not reporting in` for the Dashboard to a number that is lower than what is currently configured for the `Amount of time, in Days, to keep stale Computers before deleting` setting, and vice versa. If this is attempted, a validation warning will be shown. | ||
| </Callout> | ||
|
|
||
| <Callout type="info"> | ||
| When upgrading to Chocolatey Central Management 0.12.0, if the <Xref title="Stale Computer Retention Policy" value="ccm-administration-settings-retention" anchor="stale-computer-retention" /> is enabled, if the current value for `Amount of time, in Days, to keep stale Computers before deleting` is less than the default value for `Amount of time, in Days, before being notified of Computers not reporting in`, a change will be made to the default value to make it half of the configured value for `Amount of time, in Days, to keep stale Computers before deleting`. | ||
| </Callout> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
148 changes: 74 additions & 74 deletions
148
...cs/en-us/central-management/usage/website/administration/settings/retention.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,74 +1,74 @@ | ||
| --- | ||
| order: 50 | ||
| xref: ccm-administration-settings-retention | ||
| title: Retention Policies | ||
| description: Information about using retention settings within the Administration Settings screen | ||
| --- | ||
| import Callout from '@choco/components/Callout.astro'; | ||
| import Iframe from '@choco/components/Iframe.astro'; | ||
| import Xref from '@components/Xref.astro'; | ||
|
|
||
| Chocolatey Central Management has a number of settings that allow you to adjust various retention periods. By default, only the Audit Retention policy is enabled. | ||
|
|
||
| If you want to change these settings, follow these steps: | ||
|
|
||
| 1. Open the CCM Site in the browser. | ||
| 1. Login with the `ccmadmin` user. | ||
| 1. In the left-hand menu click on `Administration` and then `Settings`. | ||
| 1. Click on the `Retention Policies` tab | ||
|
|
||
| 1. Modify the settings as required | ||
| 1. Click the `Save All` button at the bottom left of the page to save your settings. | ||
|
|
||
|
|
||
| As noted in the User Interface, any modifications to this section of the settings will require the Web Application to be restarted. This can be completed by doing the following: | ||
|
|
||
| 1. Get direct access to the machine that is hosting the CCM Web Application | ||
| 1. Open an administrative PowerShell session | ||
| 1. Run the following commands: | ||
| ```powershell | ||
| Get-Process -Name "ChocolateySoftware.ChocolateyManagement.Web.Mvc" -ErrorAction SilentlyContinue | Stop-Process -Force | ||
| Stop-Website -Name ChocolateyCentralManagement | ||
| Restart-WebAppPool -Name ChocolateyCentralManagement | ||
| Start-Website -Name ChocolateyCentralManagement | ||
| ``` | ||
|
|
||
| ## Audit Retention | ||
|
|
||
| <Callout type="warning"> | ||
| **BREAKING CHANGE** | ||
|
|
||
| This feature was added, as a breaking change, in version 0.6.0 of Chocolatey Central Management. Audit Retention is enabled by default, and will immediately start truncating the audit log table as soon as it is installed. | ||
| If you require keeping all audit logs, we would recommend that you first back up the CCM database before applying the new version. | ||
| </Callout> | ||
|
|
||
| In an attempt to control the size of the Chocolatey Central Management database, it is possible to control the retention policy for the audit logs table within the application. | ||
|
|
||
| By default, Audit Retention is enabled, and any logs that are older than 30 days will automatically be removed. | ||
|
|
||
|  | ||
|
|
||
| ## Stale Computer Retention | ||
|
|
||
|
|
||
| <Callout type="info"> | ||
| This feature is available in Chocolatey Central Management starting with version 0.10.0. | ||
| </Callout> | ||
|
|
||
| In Chocolatey Central Management, a stale computer is one which hasn't reported in for a long period of time. This could be perfectly normal, but it could also be a sign that this computer is no longer active, and should be removed. This is something that can be done manually, given the correct permissions, from the <Xref title="computers page" value="ccm-computers" anchor="removing-a-computer-from-central-management" />, however, enabling this setting automatically removes stale computers from Chocolatey Central Management. | ||
|
|
||
| By default, Stale Computer Deletion is disabled. When it is enabled, computers that haven't reported into Chocolatey Central Management within the set timeframe (the default is 365 days) will be removed. | ||
|
|
||
|  | ||
|
|
||
| ## Deployment Plan Retention | ||
|
|
||
| <Callout type="info"> | ||
| This feature is available in Chocolatey Central Management starting with version 0.11.0. | ||
| </Callout> | ||
|
|
||
| Chocolatey Central Management has the ability to automatically archive or delete Deployment Plans that have reached a completion state. | ||
|
|
||
| By default, Deployment Plan Retention is disabled for both archiving and deleting. When it is enabled, Deployment Plans that have completed beyond the set timeframe (the default is 30 days) will be archived, or deleted. If both archive and delete are enabled, the delete period will be considered the combination of the archive and the delete. | ||
|
|
||
|  | ||
| --- | ||
| order: 50 | ||
| xref: ccm-administration-settings-retention | ||
| title: Retention Policies | ||
| description: Information about using retention settings within the Administration Settings screen | ||
| --- | ||
| import Callout from '@choco/components/Callout.astro'; | ||
| import Iframe from '@choco/components/Iframe.astro'; | ||
| import Xref from '@components/Xref.astro'; | ||
|
|
||
| Chocolatey Central Management has a number of settings that allow you to adjust various retention periods. By default, only the Audit Retention policy is enabled. | ||
|
|
||
| If you want to change these settings, follow these steps: | ||
|
|
||
| 1. Open the CCM Site in the browser. | ||
| 1. Login with the `ccmadmin` user. | ||
| 1. In the left-hand menu click on `Administration` and then `Settings`. | ||
| 1. Click on the `Retention Policies` tab | ||
|
|
||
| 1. Modify the settings as required | ||
| 1. Click the **Save All** button at the bottom left of the page to save your settings. | ||
|
|
||
|
|
||
| As noted in the User Interface, any modifications to this section of the settings will require the Web Application to be restarted. This can be completed by doing the following: | ||
|
|
||
| 1. Get direct access to the machine that is hosting the CCM Web Application | ||
| 1. Open an administrative PowerShell session | ||
| 1. Run the following commands: | ||
| ```powershell | ||
| Get-Process -Name "ChocolateySoftware.ChocolateyManagement.Web.Mvc" -ErrorAction SilentlyContinue | Stop-Process -Force | ||
| Stop-Website -Name ChocolateyCentralManagement | ||
| Restart-WebAppPool -Name ChocolateyCentralManagement | ||
| Start-Website -Name ChocolateyCentralManagement | ||
| ``` | ||
|
|
||
| ## Audit Retention | ||
|
|
||
| <Callout type="warning"> | ||
| **BREAKING CHANGE** | ||
|
|
||
| This feature was added, as a breaking change, in version 0.6.0 of Chocolatey Central Management. Audit Retention is enabled by default, and will immediately start truncating the audit log table as soon as it is installed. | ||
| If you require keeping all audit logs, we would recommend that you first back up the CCM database before applying the new version. | ||
| </Callout> | ||
|
|
||
| In an attempt to control the size of the Chocolatey Central Management database, it is possible to control the retention policy for the audit logs table within the application. | ||
|
|
||
| By default, Audit Retention is enabled, and any logs that are older than 30 days will automatically be removed. | ||
|
|
||
|  | ||
|
|
||
| ## Stale Computer Retention | ||
|
|
||
|
|
||
| <Callout type="info"> | ||
| This feature is available in Chocolatey Central Management starting with version 0.10.0. | ||
| </Callout> | ||
|
|
||
| In Chocolatey Central Management, a stale computer is one which hasn't reported in for a long period of time. This could be perfectly normal, but it could also be a sign that this computer is no longer active, and should be removed. This is something that can be done manually, given the correct permissions, from the <Xref title="computers page" value="ccm-computers" anchor="removing-a-computer-from-central-management" />, however, enabling this setting automatically removes stale computers from Chocolatey Central Management. | ||
|
|
||
| By default, Stale Computer Deletion is disabled. When it is enabled, computers that haven't reported into Chocolatey Central Management within the set timeframe (the default is 365 days) will be removed. | ||
|
|
||
|  | ||
|
|
||
| ## Deployment Plan Retention | ||
|
|
||
| <Callout type="info"> | ||
| This feature is available in Chocolatey Central Management starting with version 0.11.0. | ||
| </Callout> | ||
|
|
||
| Chocolatey Central Management has the ability to automatically archive or delete Deployment Plans that have reached a completion state. | ||
|
|
||
| By default, Deployment Plan Retention is disabled for both archiving and deleting. When it is enabled, Deployment Plans that have completed beyond the set timeframe (the default is 30 days) will be archived, or deleted. If both archive and delete are enabled, the delete period will be considered the combination of the archive and the delete. | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.