Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Ability to display already generated diagrams #6

Open
1 task
jstoiko opened this issue May 2, 2019 · 7 comments
Open
1 task

Ability to display already generated diagrams #6

jstoiko opened this issue May 2, 2019 · 7 comments
Labels
enhancement New feature or request pending Waiting for a response of feedback

Comments

@jstoiko
Copy link
Contributor

jstoiko commented May 2, 2019

  • already-generated diagrams will be in the form of SVG files and should follow a similar naming convention as the html/mardown pages, e.g. schema_<dialectSlug>_<schemaName>.svg

- [ ] illustrate relationships between all Dialects and Schemas on an index.html page
- [ ] illustrate the relationships between all the schemas used in a given Dialect

Note: look into https://bramp.github.io/js-sequence-diagrams/

@jstoiko jstoiko changed the title Replace Schemas: by a diagram Generate diagrams May 2, 2019
@postatum postatum self-assigned this Sep 11, 2019
@jstoiko jstoiko changed the title Generate diagrams Ability to display already generated diagrams Sep 20, 2019
@postatum postatum added pending Waiting for a response of feedback enhancement New feature or request labels Sep 26, 2019
@postatum
Copy link
Contributor

postatum commented Oct 1, 2019

@jstoiko please provide more details.

  1. Will these diagrams be generated by a separate command?
  2. Can't they be generated by existing command and placed directly in templates?
  3. How exactly all this should work? What's the input, output?

@jstoiko
Copy link
Contributor Author

jstoiko commented Oct 1, 2019

Yes, that's the idea. There will be a separate command to generate those diagrams, say aml2svg. It may be ran before running aml2html, aml2html needs to provide a way to add those diagrams to the templates.

@mattdfuchs
Copy link

I've added aml2uml repo to mulesoft-labs which can regenerate diagrams.

@postatum
Copy link
Contributor

postatum commented Oct 4, 2019

I've added aml2uml repo to mulesoft-labs which can regenerate diagrams.

I get 404 at https://github.com/mulesoft-labs/aml2uml

@mattdfuchs
Copy link

mattdfuchs commented Oct 4, 2019 via email

@jstoiko
Copy link
Contributor Author

jstoiko commented Oct 4, 2019

@postatum
Copy link
Contributor

postatum commented Oct 5, 2019

@postatum: moved - https://github.com/aml-org/aml2uml

Good, thanks. Few more questions:

  1. Should I just provide a way to display svgs generated somewhere else or should aml2html also use aml2uml to generate them?
  2. Will the diagrams be generated for dialects, schemas or both?
  3. Where the diagrams should be displayed? Separate page, somewhere in a specific place on the page?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request pending Waiting for a response of feedback
Projects
None yet
Development

No branches or pull requests

3 participants