[TechDocs] Enhance PlantUML support in the techdocs container to include external puml or pu files #63
Conversation
lavanya-sainik-ericsson
force-pushed
the
plantuml-support-enhancement
branch
from
2b0e222 to
68f65c0
Compare
There was a problem hiding this comment.
Thanks again for this contribution @lavanya-sainik-ericsson, just left a couple of quick changes 👍
Dockerfile
Outdated
| @@ -26,6 +26,11 @@ RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==1.2.2 | |||
| # error (OSError: [Errno 8] Exec format error: 'plantuml') by using the | |||
| # following RUN command instead: | |||
| # RUN echo '#!/bin/sh\n\njava -jar '/opt/plantuml.jar' ${@}' >> /usr/local/bin/plantuml | |||
|
|
|||
| # When adding TechDocs with plantUml diagrams, to refer external puml or pu files in any markdown file, | |||
There was a problem hiding this comment.
| # When adding TechDocs with plantUml diagrams, to refer external puml or pu files in any markdown file, | |
| # When adding TechDocs with PlantUML diagrams, to refer external puml or pu files in any markdown file, |
Dockerfile
Outdated
| @@ -26,6 +26,11 @@ RUN pip install --upgrade pip && pip install mkdocs-techdocs-core==1.2.2 | |||
| # error (OSError: [Errno 8] Exec format error: 'plantuml') by using the | |||
| # following RUN command instead: | |||
| # RUN echo '#!/bin/sh\n\njava -jar '/opt/plantuml.jar' ${@}' >> /usr/local/bin/plantuml | |||
|
|
|||
| # When adding TechDocs with plantUml diagrams, to refer external puml or pu files in any markdown file, | |||
| # eg. '!include <referencedFileName.puml>', need to include diagrams directory eg. docs in the classpath. | |||
There was a problem hiding this comment.
| # eg. '!include <referencedFileName.puml>', need to include diagrams directory eg. docs in the classpath. | |
| # eg. '!include <referencedFileName.puml>', you'll need to include the diagrams directory eg. docs in the classpath. |
…ude external puml or pu files Issue #20184 Signed-off-by: Lavanya Sainik <lavanya.sainik@ericsson.com>
lavanya-sainik-ericsson
force-pushed
the
plantuml-support-enhancement
branch
from
68f65c0 to
3091ce1
Compare
|
Hello awanlin, Thanks for your comments. Have done those changes. Let me know if any more corrections is needed. |
There was a problem hiding this comment.
Looks good to me @lavanya-sainik-ericsson, you'll need someone from @backstage/techdocs-maintainers to review and approve, they will also do the merge
|
Hey awanlin, Thanks a lot for your feedback and approval. Sure can you share how to request reviews from @backstage/techdocs-maintainers here & request their attention & valuable feedback as here I cannot see @backstage/techdocs-maintainers tagged but they are automatically tagged in other PR backstage/backstage#20229 or not sure if I am missing anything ? Let me know your views here whenever you get time :). |
I have created a pull request for the issue I have outlined on backstage. Please refer here : backstage/backstage#20184.
awanlin As discussed in the issue thread, looping you here as well to have a look.