Add troubleshooting for PlantUML configuration
What does this MR do and why?
Document why rendered diagram PNG URL is not getting updated.
This came out of investigating a customer ticket (internal link): https://gitlab.zendesk.com/agent/tickets/542987
MR acceptance checklist
Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
Screenshots or screen recordings
Screenshots are required for UI changes, and strongly recommended for all other merge requests.
| Description | Screenshots |
|---|---|
| Initial PlantUML URL |  |
| Before PlantUL URL update |  |
| After PlantUML URL update (URL is not updated in the UI) |  |
| After clearing Redis cache or committing new change (URL is updated in the UI) |  |
| Before | After |
|---|---|
| Section does not exist before |
|
How to set up and validate locally
- Set up GitLab and PlantUML servers on the same network
- Add a Markdown file of the PlantUML example to a respository
- Enable PlantUML integration and check that the PlantUML diagram is rendered
- Update the PlantUML in Admin Area settings to a different URL, refresh the page and see it does not get updated
- Follow the troubleshooting steps to render the new URL
Edited by Daphne Kua