Comments & Notes on Resources

You can attach a note to any resource to explain why it’s configured the way it is — useful context for teammates, or for your future self, reading the lab later. Notes are part of the lab’s source, so a note added in the UI shows up in the code, and a note written in code shows up in the UI.

Adding a note

In edit mode, a comment icon (a speech bubble) appears next to a field or section label on a resource — for example next to a container’s Name or Image. Click it to open a note popover with two placement options:

• Leading — Above this element — a note placed above the element in the configuration, for a fuller explanation that introduces what follows.
• Inline — On the same line — a short note on the same line as the element.

Type your note in the Leading or Inline area to add it, reopen the popover to edit it, and clear the text to remove it. Notes are only available in edit mode.

Syncing between the UI and code

Notes live in the lab’s HCL alongside the resource they annotate, so they travel with the lab through version control like any other change. Add a note in the UI and it appears in the code; write one in code and it appears in the UI. This keeps the reasoning behind a configuration attached to the configuration itself, wherever your teammates are working.