Add Group Policy Docs #806
Conversation
|
Learn Build status updates of commit 88de1e3: 💡 Validation status: suggestions
TerminalDocs/group-policy.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
|
Learn Build status updates of commit bc3d296: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
TerminalDocs/group-policy.md
Outdated
|
|
||
| ### Download | ||
|
|
||
| You can find the latest administrative templates (ADMX and ADML files) in the assets section of our newest Windows Terminal release on GitHub. The file is named `GroupPolicyTemplates-<Version>.zip` |
There was a problem hiding this comment.
We could add a link to https://github.com/microsoft/terminal/releases/latest here.
TerminalDocs/group-policy.md
Outdated
| ### Add the administrative template to an individual computer | ||
|
|
||
| 1. Copy the `WindowsTerminal.admx` file to your **Policy Definition** template folder. (Example: `C:\Windows\PolicyDefinitions`) | ||
| 2. Copy the `WindowsTerminal.adml` file to the matching language folder in your language folder in your Policy Definition folder. (Example: `C:\Windows\PolicyDefinitions\en-US`) |
There was a problem hiding this comment.
Should we simplify the two steps to just say that one should copy the .zip contants as-is into the policy folder?
There was a problem hiding this comment.
If it contains admx and en-us folder with adml, extracting the zip is as simple as possible.
There was a problem hiding this comment.
Good points. I tried to follow the patterns set in the PowerToys Group Policy doc when I wrote this.
Since we only have en-us right now, perhaps having one step that says extracting the zip to Policy Definition is the best option :)
TerminalDocs/group-policy.md
Outdated
| 1. On a domain controller or workstation with RSAT, go to the **PolicyDefinition** folder (also known as the Central Store) on any domain controller for your domain. <br> | ||
| For older versions of Windows Server, you might need to create the PolicyDefinition folder. For more information, see [How to create an manage the Central Store for Group Policy Administrative Templates in Windows](/troubleshoot/windows-client/group-policy/create-and-manage-central-store). | ||
| 2. Copy the `WindowsTerminal.admx` file to the **PolicyDefinition** folder. (Example: `%systemroot%\sysvol\domain\policies\PolicyDefinitions`) | ||
| 3. Copy the `WindowsTerminal.adml` file to the matching language folder in your language folder in your Policy Definition folder. Create the folder if it does not already exist (Example: `%systemroot%\sysvol\domain\policies\PolicyDefinitions\EN-US`) |
There was a problem hiding this comment.
You can always use en-us as this is the fallback language. If no correct language exists en-us is used.
Or do you plan to provide translated admlnfor different languages?
TerminalDocs/group-policy.md
Outdated
| ### Disabled Source Profiles | ||
|
|
||
| This policy disables source profiles from being generated. Source names can be arbitrary strings. Potential candidates can be found as the "source" property on profile definitions in Windows Terminal's `settings.json` file. |
There was a problem hiding this comment.
Add note in here about the first WT version supporting this policy. (Same for the second one.)
TerminalDocs/group-policy.md
Outdated
|
|
||
| For instance, setting this policy to `OpenAI` will allow the use of OpenAI in Terminal Chat. | ||
|
|
||
| #### Disabling Terminal Chat |
There was a problem hiding this comment.
| #### Disabling Terminal Chat | |
| **Disabling Terminal Chat** |
Is maybe more clear. It's not a new policy.
TerminalDocs/group-policy.md
Outdated
|
|
||
| ### Import the administrative template in Intune | ||
|
|
||
| You can find all instructions on how to import the administrative template in Intune on [Import custom ADMX and ADML administrative templates into Microsoft Intune](/mem/intune/configuration/administrative-templates-import-custom#add-the-admx-and-adml-files) |
There was a problem hiding this comment.
Important: As the admx contain a reference to Windows.admx you can't import the WT admx without having the other one. Otherwise Intune complains about not resolved references.
(Never tested by myself. But read somewhere in the past.)
There was a problem hiding this comment.
@htcfreek That is a good point. I can add that note to the PR in a new line:
You will also need to import `Windows.admx` since the Windows Terminal ADMX files contains references to that file.
How does this sound?
|
Learn Build status updates of commit 2f6eb3f: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit fca9ef2: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
The docs for PowerToys and Edge containing additional information about the policy and their corresponding registry key. I not sure if the additional policy info (file name, id, display name, category) are required with this small set. But the registry information would be very helpful for people that can't use the admx for some reasons. Additionally in the PowerToys docs we added additional intune information. Maybe you like to add them here to. (Not a must have.) |
Co-authored-by: Heiko <[email protected]>
Co-authored-by: Heiko <[email protected]>
|
Learn Build status updates of commit d4248fe: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit 1be71a6: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit 8d49d1f: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Thanks for the suggestions @htcfreek! I added in your commit suggestions and sections for Group Policy information and Registry information :) I think we should be good to go now! |
TerminalDocs/group-policy.md
Outdated
|
|
||
| ### Add the administrative template to an individual computer | ||
|
|
||
| 1. Unzip the `GroupPolicyTemplates-<Version>.zip` file to your **Policy Definition** template folder. (Example: `C:\Windows\PolicyDefinitions`) |
There was a problem hiding this comment.
Example makes no sense. There is only this one directory.
There was a problem hiding this comment.
You have a point about the usage of the word "example"
I used it because that is what the PowerToys docs use. I will remove that word. I still think having the path is valuable for those who are new to setting up policies so I will change it to "located in" (or just remove it entirely) instead.
There was a problem hiding this comment.
Remove word Example and move dot behind brackets.
TerminalDocs/group-policy.md
Outdated
| 1. Unzip the `GroupPolicyTemplates-<Version>.zip` file to your **Policy Definition** template folder. (Example: `C:\Windows\PolicyDefinitions`) | ||
|
|
||
| > [!NOTE] | ||
| > The `WindowsTerminal.adml` file in the `en-US` folder will apply the policy even if you are not using an `en-US`-based machine. |
There was a problem hiding this comment.
My two cents on this:
- The admx/adml never applies something. They work (as templates).
- The language/adml has nothing to with the registry key. The are only used to define displaying information for the configuration tool.
Better: Use the text from the box for domain import.
There was a problem hiding this comment.
Nice catch! I totally forgot to change this note in my last edit. It should now be updated :)
|
Learn Build status updates of commit 752c16d: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Co-authored-by: Heiko <[email protected]>
Co-authored-by: Heiko <[email protected]>
|
I committed your suggestions! Thanks for taking the time to help on this @htcfreek! |
|
Learn Build status updates of commit 597893d: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit 12b2c56: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit 450e342: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Addresses microsoft/terminal#18095 and microsoft/terminal#18009