Docs: Add migration guide from blockdiag/seqdiag to Mermaid 38/143438/1
authorMatthew Watkins <mwatkins@linuxfoundation.org>
Tue, 3 Mar 2026 15:16:43 +0000 (15:16 +0000)
committerMatthew Watkins <mwatkins@linuxfoundation.org>
Tue, 3 Mar 2026 15:16:43 +0000 (15:16 +0000)
commit4574530654bddf9a37134f66a4c82c7221554e11
tree07038c35001f78a20b3a548d33e134b432da4b2b
parent67ae5439e52bf07878996898722601b5abce6eab
Docs: Add migration guide from blockdiag/seqdiag to Mermaid

sphinxcontrib-blockdiag and sphinxcontrib-seqdiag have not been maintained
since December 2021 and are incompatible with Python 3.12+
(ast.NameConstant removal) and Pillow 10+ (ImageDraw.textsize removal).

This adds a comprehensive documentation guide that:
- Details the problems with the current blockdiag/seqdiag extensions
- Evaluates alternatives (Mermaid, PlantUML, Graphviz)
- Recommends sphinxcontrib-mermaid as the replacement
- Provides step-by-step migration instructions for repositories
- Includes syntax conversion examples for both block and sequence
  diagrams
- Lists the changes needed in doc repo files (conf.py,
  requirements-docs.txt, upper-constraints.onap.txt)
- Provides a downstream repository migration checklist

Issue-ID: CIMAN-33
Change-Id: I3b6ce0eb31fca0f9ea36cbca75575b3ba6a33ea4
Signed-off-by: Matthew Watkins <mwatkins@linuxfoundation.org>
docs/guides/onap-documentation/diagrams-blockdiag-to-mermaid.rst [new file with mode: 0644]
docs/guides/onap-documentation/index.rst