Как заменить диаграммы русалок изображениями, сохраняя их в формате уценки, чтобы обеспечить легкий предварительный просмотр в TFS / Azure DevOps Server?

Question

Компания, в которой я работаю, решила хранить требования в формате уценки, чтобы обеспечить простоту, справочную возможность и предварительный просмотр непосредственно на TFS / Azure DevOps Server. Вопрос в предварительном просмотре в TFS / Azure Dev Ops Server. Как я обнаружил, он поддерживает: HTML-теги, математические формулы, изменение размера изображений, упоминание о запросах, пользователи, рабочие элементы и так далее. Но диаграммы русалок не поддерживаются , хотя, на мой взгляд, они очень полезны для общего понимания сложных процессов в кратчайшие сроки.

Я установил pandoc, и это процесс: автоматически генерировать HTML-файл для каждого обновленного md-файла в REPO Проблема в том, что TFS / Azure DevOps Server не принимает предварительный просмотр изображений в кодировке BASE64, встроенных в HMTL от pandoc.

Итак, я решил сделать что-то подобное:

• для каждого обновленного md-файла создайте копию с постфиксом (*** _ IMG.md)
  • для каждой диаграммы русалки
    • создание PNG-изображения
    • сохранить изображение PNG в папке с изображениями
    • заменить диаграмму русалки ссылкой на сгенерированное изображение
• сохранить измененный файл md

Можно ли указать список программного обеспечения для достижения этого решения? Я не нашел ответа на каком инструменте я должен использовать, я думаю, Python? Но могут быть какие-то другие альтернативы?

Answer 1

Это проще, чем вы думаете.Вики-сервер TFS / Azure Wiki поддерживается хранилищем Git , поэтому ваш процесс может выглядеть примерно так:

• git pull
• сканировать файлы репо, чтобы найтидиаграммы русалок
• генерируют JPG и заменяют фрагмент ссылкой на изображение
• git commit
• git push

Это может быть легко автоматизированов конвейере и, возможно, в расширении, таком как Git Tools для Azure DevOps , это может сделать работу еще проще.

Answer 2

Альтернативный подход к включению простых UML в вашу TFS / Azure Wiki Dev Ops: yUML.me .

Просто добавьте тег <img> к вашей уценке, включая синтаксис UML,например.

<img src="http://yuml.me/diagram/scruffy/class/%2F%2F Cool Class Diagram, [Customer|-forname:string;surname:string|doShiz()]<>-orders*>[Order], [Order]++-0..*>[LineItem], [Order]-[note:Aggregate root{bg:wheat}].jpg">

Это добавит изображение на вашу страницу вики:

Множество образцовможно найти здесь: https://yuml.me/diagram/scruffy/class/samples

Конечно, у этого есть некоторые ограничения, такие как максимальная длина Uri, но я нашел это весьма полезным для небольших UML, и вы можете увидеть результат в реальном времени на вкладке предварительного просмотра.когда вы набираете синтаксис Uml.

Я не тестировал его с сервером AzureDevOps, но в TFS 2018 он работает как чудо.