diff --git a/windows/client-management/mdm/contribute-csp-reference.md b/windows/client-management/mdm/contribute-csp-reference.md new file mode 100644 index 0000000000..f5abd13c99 --- /dev/null +++ b/windows/client-management/mdm/contribute-csp-reference.md @@ -0,0 +1,86 @@ +--- +title: Contributing to CSP reference articles +description: Learn more about contributing to the CSP reference articles. +author: vinaypamnani-msft +manager: aaroncz +ms.author: vinpa +ms.date: 05/11/2023 +ms.localizationpriority: medium +ms.prod: windows-client +ms.technology: itpro-manage +ms.topic: ref +--- + +# Contributing to the CSP reference articles + +CSP reference articles are automatically generated using the [device description framework (DDF)](configuration-service-provider-ddf.md) v2 files that define the CSP. When applicable, the CSP definition includes a mapping to a group policy. These mappings are utilized by the automation, when possible, to provide a friendly description for the CSP policies. + +> [!IMPORTANT] +> Each automated CSP article provides editable sections to provide additional information about the CSP or the policies within the CSP. Any edits outside the designated editable sections are overwritten by the automation. + +## CSP article structure + +Each automated CSP article is broken into three sections. + +> [!NOTE] +> To view these sections, visit the article that you want to update, then select the **Pencil** icon +> +> :::image type="content" source="../../../images/pencil-icon.png" alt-text="Screenshot showing the Pencil icon to edit a published article"::: + +1. **Header**: The header includes the CSP name, and provides an editable section where additional information about the CSP can be provided. + + :::image type="content" source="images/csp-header.png" alt-text="Screenshot of the CSP header section"::: + +1. **Policies**: The policies section contains a list of policies, where each policy has an editable section for providing additional information and examples. + + :::image type="content" source="images/csp-policy.png" alt-text="Screenshot of the CSP policy section"::: + +1. **Footer**: The footer indicates the end of the CSP article, and provides an editable section where more information about the CSP can be provided. + + :::image type="content" source="images/csp-footer.png" alt-text="Screenshot of the CSP footer section"::: + +## Provide feedback on documentation + +As most of the CSP articles are automated, the feedback for these articles is best addressed when submitted using [Feedback Hub app](https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332). However for non-automated content, use the guidance for [Editing Windows IT professional documentation](../../../CONTRIBUTING.md). + +Use the sections below to determine where you should submit feedback. + +### Feedback for policy description + +Policy descriptions are sourced from DDF or ADMX files and are located within the `<[CSP-Name]-Description-Begin>` section for the policy in the markdown file. `<[CSP-Name]-Description-Begin>` also includes a reference to the source that was used to provide the policy description. + +- `Description-Source-ADMX` or `Description-Source-ADMX-Forced`: The description was captured from the group policy that the CSP setting maps to. If this description is incorrect, [Send feedback to Microsoft with the Feedback Hub app](https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332). +- `Description-Source-DDF` or `Description-Source-DDF-Forced`: The description was captured from the DDF file that defines the CSP. If this description is incorrect, [Send feedback to Microsoft with the Feedback Hub app](https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332). +- `Description-Source-Manual-Forced`: The description is defined in the automation code. If this description is incorrect, [submit a GitHub issue](../../../CONTRIBUTING.md#using-issues-to-provide-feedback-on-documentation). + +Any additional information about the policy setting can be provided in the `[Policy-Name]-Editable-Begin` section that immediately follows the `<[CSP-Name]-Description-End>` section. This section provides the ability to further expand the policy description, and is generated manually. For any feedback for the editable content, use the guidance for [Editing Windows IT professional documentation](../../../CONTRIBUTING.md) to update the section or submit an issue. + +### Feedback for policy examples + +Policy examples are not provided by the automation. Each policy node in the markdown file includes a `[Policy-Name]-Examples-Begin` section which contains the examples. If the example is incorrect or needs to be updated, use the guidance for [Editing Windows IT professional documentation](../../../CONTRIBUTING.md) to update the example or submit an issue. + +### Feedback for policy applicability + +Policy applicability is defined in the DDF v2 file for the CSP. Each policy node in the markdown file includes a `[Policy-Name]-Applicability-Begin` section which contains the operating system applicability. + +If it is incorrect or needs to be updated, [Send feedback to Microsoft with the Feedback Hub app](https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332). + +### Feedback for policy allowed values + +Policy allowed values are defined in the DDF v2 file for the CSP. When applicable, each policy node in the markdown file includes a `[Policy-Name]-AllowedValues-Begin` section which contains the operating system applicability. + +If these values are incorrect or need to be updated, [Send feedback to Microsoft with the Feedback Hub app](https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332). + +### Feedback for group policy mapping + +Group policy mappings are defined in the DDF v2 file for the CSP. When applicable, each policy node in the markdown file includes a `[Policy-Name]-AdmxBacked-Begin` or `[Policy-Name]-GpMapping-Begin` section which contains the group policy mapping. + +If this mapping is incorrect, [Send feedback to Microsoft with the Feedback Hub app](https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332). + +### Other feedback + +For any other feedback, use the guidance for [Editing Windows IT professional documentation](../../../CONTRIBUTING.md). + +## Related articles + +- [Contributor guide overview](https://learn.microsoft.com/contribute/) \ No newline at end of file diff --git a/windows/client-management/mdm/images/csp-footer.png b/windows/client-management/mdm/images/csp-footer.png new file mode 100644 index 0000000000..96f052dd8e Binary files /dev/null and b/windows/client-management/mdm/images/csp-footer.png differ diff --git a/windows/client-management/mdm/images/csp-header.png b/windows/client-management/mdm/images/csp-header.png new file mode 100644 index 0000000000..f2bfd8d284 Binary files /dev/null and b/windows/client-management/mdm/images/csp-header.png differ diff --git a/windows/client-management/mdm/images/csp-policy.png b/windows/client-management/mdm/images/csp-policy.png new file mode 100644 index 0000000000..8ed5ebfe8f Binary files /dev/null and b/windows/client-management/mdm/images/csp-policy.png differ diff --git a/windows/client-management/mdm/policy-csp-admx-cpls.md b/windows/client-management/mdm/policy-csp-admx-cpls.md index 30bfe07997..a26e4e3813 100644 --- a/windows/client-management/mdm/policy-csp-admx-cpls.md +++ b/windows/client-management/mdm/policy-csp-admx-cpls.md @@ -1,6 +1,6 @@ --- -title: ADMX_Cpls Policy CSP -description: Learn more about the ADMX_Cpls Area in Policy CSP. +title: [CSP-Name] Policy CSP +description: Learn more about the [CSP-Name] Area in Policy CSP. author: vinaypamnani-msft manager: aaroncz ms.author: vinpa @@ -13,83 +13,74 @@ ms.topic: reference - -# Policy CSP - ADMX_Cpls + +# Policy CSP - [CSP-Name] [!INCLUDE [ADMX-backed CSP tip](includes/mdm-admx-csp-note.md)] - + - + - -## UseDefaultTile + +## [Policy-Name] - + | Scope | Editions | Applicable OS | |:--|:--|:--| -| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE | ✅ Windows 10, version 2004 [10.0.19041.1202] and later
✅ Windows 10, version 2009 [10.0.19042.1202] and later
✅ Windows 10, version 21H1 [10.0.19043.1202] and later
✅ Windows 11, version 21H2 [10.0.22000] and later | - +| ✅ Device
❌ User | ✅ Pro
✅ Enterprise
✅ Education
✅ Windows SE | ✅ Windows 10, version 21H1 [10.0.19043.1202] and later | + - + ```Device -./Device/Vendor/MSFT/Policy/Config/ADMX_Cpls/UseDefaultTile +./Device/Vendor/MSFT/Policy/Config/[CSP-Name]/[Policy-Name] ``` - + - + -This policy setting allows an administrator to standardize the account pictures for all users on a system to the default account picture. One application for this policy setting is to standardize the account pictures to a company logo. +This policy setting allows an administrator to... + -> [!NOTE] -> The default account picture is stored at %PROGRAMDATA%\Microsoft\User Account Pictures\user.jpg. The default guest picture is stored at %PROGRAMDATA%\Microsoft\User Account Pictures\guest.jpg. If the default pictures don't exist, an empty frame is displayed. - -- If you enable this policy setting, the default user account picture will display for all users on the system with no customization allowed. - -- If you disable or don't configure this policy setting, users will be able to customize their account pictures. - - - + - + - + **Description framework properties**: | Property name | Property value | |:--|:--| | Format | `chr` (string) | | Access Type | Add, Delete, Get, Replace | - + - + [!INCLUDE [ADMX-backed policy note](includes/mdm-admx-policy-note.md)] **ADMX mapping**: | Name | Value | |:--|:--| -| Name | UseDefaultTile | -| Friendly Name | Apply the default account picture to all users | -| Location | Computer Configuration | -| Path | Control Panel > User Accounts | -| Registry Key Name | Software\Microsoft\Windows\CurrentVersion\Policies\Explorer | -| Registry Value Name | UseDefaultTile | -| ADMX File Name | Cpls.admx | - +| Name | [Policy-Name] | +| Friendly Name | [Group policy friendly name] | +| Location | [Computer/User Configuration] | +| Path | [Group policy path] | +| ADMX File Name | [ADMX-File-Name] | + - + - + - + - + - + - + ## Related articles -[Policy configuration service provider](policy-configuration-service-provider.md) +[Policy configuration service provider](policy-configuration-service-provider.md) \ No newline at end of file diff --git a/windows/client-management/mdm/toc.yml b/windows/client-management/mdm/toc.yml index e4247312ed..337d5633e1 100644 --- a/windows/client-management/mdm/toc.yml +++ b/windows/client-management/mdm/toc.yml @@ -3,6 +3,8 @@ items: href: index.yml expanded: true items: + - name: Contributing to CSP reference + href: contribute-csp-reference.md - name: Device description framework (DDF) files href: configuration-service-provider-ddf.md - name: Support scenarios