Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Concerns about images being used #91

Open
darraghbr opened this issue Jan 19, 2021 · 1 comment
Open

Concerns about images being used #91

darraghbr opened this issue Jan 19, 2021 · 1 comment

Comments

@darraghbr
Copy link

The concern I have with using the dynamically generated images is that it is challenging to link to other areas in the docs.

For instance on the stakeholders concerns and requirements, ideally we would be able to click on a requirement ID and see everywhere that requirement ID is referenced across any docs, test specs results etc.

I think a better approach is to just use tables as set out in the Helpful Engineering templates.

@capsulecorplab
Copy link
Member

@darraghbr thanks for the concern. It's worth noting that both a diagram and a table are merely views of the content, not the content itself. That being said, plantuml, which is the underlying plaintext modeling language we're using to construct these views, does support embedded links, and asciidoc supports tables. I'm currently investigating a workflow for being able to parse and embedd plantuml elements into asciidoc, using liquidocs, so you'll likely see this use case accommodated for soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants