Production guides

Production guides provide same-page field- and widget-level instructions to editors, such as:

• Whether the field is optional.
• How many characters the field supports.
• Strategic guidance on tense, word usage.
• General information about the fields included on the page.
• Directions pertaining to widgets, like redirect instructions for the URLs widget, or guidance on site ownership

Production guides can be enabled at any level of the content hierarchy, and will be inherited by lower levels. For example, if the feature is enabled at the global level, it will be enabled at the site and user levels.

Production guide fields are editable only to users with the right permissions.

Enabling production guides

You can enable production guides at the global, site, role, user, and profile level. If you enable production guides guides at a higher level of hierarchy, the feature is inherited by lower levels.

To enable permissions for production guides:

1. Do one of the following:

   To enable production guides at the...	Start by...
   Global level	Click > Admin > Sites & Settings > Sites > Global From the CMS tab, expand the UI cluster.
   Site level	Click > Admin > Sites & Settings. In the Sites widget, select the site for which you want to enable this feature. From the CMS tab, expand the UI cluster.
   User level	Click > Admin > Users & Roles. Select the user for whom you want to enable this feature. Under CMS, expand UI.
   Profile level	In the header, click your username > Profile. Under CMS, expand UI.

2. Under Enable Guides, select one of the following:

   1. Enabled—Turns on production guides for this level of hierarchy and all below it.
   2. Disabled—Turns off production guides for this level of hierarchy and all below it.

3. Click Save.

Accessing production guides

You can access production guides in one of two ways:

1. By opening the production guides pane from any page in Brightspot.
2. By clicking the help icon above a field.

To access the production guides pane:

• From the left rail, click Guide. A panel opens to the right that provides descriptions of the fields and widgets in page you are viewing.

Note

Once opened, the production guides panel remains open. To hide the production guides panel, click help icon once again.

Once the production guides panel is open, clicking help icon again takes you to the corresponding description.

To access production guides from a field:

1. When viewing a field in Brightspot, hover your cursor over the field title.
2. Click help icon to open a pop-up that includes a description of the field.

Adding and editing production guides

There are two types of adding and editing actions for production guides—for fields and for widgets. This topic describes both actions.

Only editors with the proper permissions can add and edit production guides.

Note

There is no limit to the number of characters you can add to a production guide.

To add or edit production guides for fields:

1. From the header, click to open production guides.

2. Click .

   

3. Under Fields, click a field's cluster to open it.

4. Toggle on Standalone to prevent this field description from being shared to production guides for other content types that include this field. (If the field only exists in the current content type, the Standalone toggle does not appear.)

5. In the Description field, describe how your organization uses this field.

6. Repeat as necessary for other fields.

7. Click Save.

To add or edit production guides for widgets:

1. From the header, click to open production guides.

2. To add or edit production guides for widgets, do the following:

3. Scroll to the widget guide you want to add or edit (or click its title in the content edit form to navigate directly to it).

4. Click .

   

5. In the Description field, describe how your organization uses this widget.

6. Toggle on Standalone to prevent this widget's description from being shared to other production guides.

7. Repeat as necessary for other widgets.

8. Click Save.

Enabling editing permissions for production guides

You can enable editing permissions for production guides at the role level.

To enable editing permissions for production guides:

1. Click > Admin > Users & Roles.

2. In the Roles widget, select the role for which you want to enable editing permissions for production guides.

3. Under Permission Settings, in the UI field, click one of the following:

   • All—Enables all UI permissions, including those for production guides.
   • All Except—Enables all UI permissions except those you specify. Ensure that Edit Guide Field Editorial Note is enabled.
   • Only—Enables only those UI permissions that you specify. Ensure that Edit Guide Field Editorial Note is included in the list.

4. Click Save.

Deprecating production guides

Editors with the proper permissions can deprecate individual production guide descriptions for fields and widgets. This involves removing the text from the descriptions of the guides.

Caution

Deprecating a production guide for a field or widget that is shared (not standalone) removes the description in every instance where it appears.

To deprecate production guides for fields:

1. In the header, click .
2. Click the content type whose production guide you want to view (for example, Article).
3. From the header, click to open production guides for the asset.
4. Click .
5. Under Fields, expand the field whose description you want to remove.
6. Delete the text in the Description field.
7. Click Save.

To deprecate production guides for widgets:

1. In the header, click .
2. Click the content type whose production guide you want to view (for example, Article).
3. From the header, click to open production guides for the asset.
4. In the content edit form, click on the widget title to automatically navigate to its location in the production guide panel.
5. Click .
6. Delete the text in the Description field.
7. Click Save.

Setting production guides to be open by default

You can set production guides to be open by default.

To set the production guide panel as open by default for users:

1. In the header, click your username > Profile.

2. Under Main, toggle on Guide Open.

   

3. Click Save.