Commit 0f7626dd authored by Chris Sharp's avatar Chris Sharp Committed by Commit Bot

Add guidelines for policy descriptions.

Currently this will just focus on getting product names referenced the
same way in all policies.

Change-Id: I53a2442c79f18f79c5c31d89c01e10c74a1e8e87
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2303528
Commit-Queue: Chris Sharp <csharp@chromium.org>
Reviewed-by: default avatarOwen Min <zmin@chromium.org>
Reviewed-by: default avatarJulian Pastarmov <pastarmovj@chromium.org>
Cr-Commit-Position: refs/heads/master@{#792010}
parent 1ea5e8d0
......@@ -81,6 +81,10 @@
# for correct re-flowing of the text.
# [1] https://www.chromium.org/developers/tools-we-use-in-chromium/grit/grit-users-guide.
#
# See documentation in docs/enterprise/components/policy/resources/description_guidelines.md
# for how product names should appear in <ph> tags to ensure consistency.
#
#
# Generated grd names:
# Each name has two parts: the second part is either CAPTION, DESC or LABEL,
# and the first part identifies the item the text applies to:
......@@ -65,6 +65,9 @@ Usually you need a policy when
traditionally, and we've seen requests from organizations to
explicitly spell out the behavior for all possible values and for
when the policy is unset.
- See [description_guidelines.md](https://chromium.googlesource.com/chromium/src/+/refs/heads/master/docs/enterprise/description_guidelines.md)
for additional guidelines when creating a description, including how
various products should be referenced.
3. Create a preference and map the policy value to it.
- All policy values need to be mapped into a prefs value before being used
unless the policy is needed before PrefService initialization.
......
To ensure consistency in policy descriptions, the following is a mapping of
how various product names and the like should be referenced.
Chrome: <ph name="PRODUCT_NAME">$1<ex>Google Chrome</ex></ph>
Chrome OS: <ph name="PRODUCT_OS_NAME">$2<ex>Google Chrome OS</ex></ph>
Linux: <ph name="LINUX_OS_NAME">Linux</ph>
Internet Explorer: <ph name="IE_PRODUCT_NAME">Internet® Explorer®</ph>
Google Cast: <ph name="PRODUCT_NAME">Google Cast</ph>
Google Drive: <ph name="GOOGLE_DRIVE_NAME">Google Drive</ph>
Windows: <ph name="MS_WIN_NAME">Microsoft® Windows®</ph>
Microsoft ActiveDirectory: <ph name="MS_AD_NAME">Microsoft® Active Directory®</ph>
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment