Updating [agent.config] needs updating [agent] too

[sandervandevelde]

The documentation tells me to update the [agent.config] section:

[agent.config]
image: "mcr.microsoft.com/azureiotedge-agent:1.5"

if the [agent] section is still commented out, this will lead to a generic error:

abc@xyz:/etc/aziot$ sudo iotedge config apply
Command failed: could not parse config file: TOML parse error at line 1, column 1
  |
1 | # ==============================================================================
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
missing field `name`

To fix this error, uncomment the [agent] section too:

[agent]
name = "edgeAgent"
type = "docker"

Be sure to put this above the [agent.config] section.

This has to be part of the documentation too, step 6 of this Update parent configuration file.

The same goes for the 'Update downstream configuration file' section too, I expect.

---

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

• ID: cf391207-5570-8bd5-7093-9ace84259f61
• Version Independent ID: 1f885aee-a2bf-2e30-814e-460048ec657b
• Content: How to create nested Azure IoT Edge device hierarchies
• Content Source: articles/iot-edge/how-to-connect-downstream-iot-edge-device.md
• Service: iot-edge
• GitHub Login: @PatAltimore
• Microsoft Alias: patricka

[TPavanBalaji]

@sandervandevelde
Thanks for your feedback! We will investigate and update as appropriate.

[TPavanBalaji]

@sandervandevelde
Thank you for bringing this to our attention.
I've delegated this to content author, who will review it and offer their insightful opinions.