Missing Lightning page descriptions
Why is this an issue?
Orgs accumulate Lightning pages quickly, and several pages for the same object often end up with near-identical names. Descriptions help administrators:
Tell similar pages apart before editing the wrong one
Record what a page is for, and who it was built for, next to the page itself
Examples
Example of incorrect metadata:
<FlexiPage>
<masterLabel>Account Record Page</masterLabel>
<type>RecordPage</type>
</FlexiPage>
Example of correct metadata:
<FlexiPage>
<description>Record page for Accounts, used by the sales team. Shows the renewal panel for customers only.</description>
<masterLabel>Account Record Page</masterLabel>
<type>RecordPage</type>
</FlexiPage>
How can I fix violations?
Add a description saying what the page is for and who it was built for:
Open the page in the Lightning App Builder
Click an empty area of the canvas, or Page in the breadcrumb, to show the page's own properties
Fill in the Description field, which holds up to 255 characters
Click Save
When should I disable this rule?
You may dismiss specific violations for pages kept only for testing or migration.
Resources