Add clarifying comment

elastic · Jul 5, 2022 · 78f7eec · 78f7eec
1 parent 6bd8326
commit 78f7eec
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/x-pack/plugins/fleet/public/hooks/use_fleet_status.tsx b/x-pack/plugins/fleet/public/hooks/use_fleet_status.tsx
@@ -23,6 +23,10 @@ interface FleetStatusState {
 
 interface FleetStatus extends FleetStatusState {
   refresh: () => Promise<void>;
+
+  // This flag allows us to opt into displaying the Fleet Server enrollment instructions even if
+  // a healthy Fleet Server has been detected, so we can delay removing the enrollment UI until
+  // some user action like clicking a "continue" button
   forceDisplayInstructions: boolean;
   setForceDisplayInstructions: React.Dispatch<boolean>;
 }