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

Documentation schemas issue #160

Closed
vtedesco opened this issue Dec 29, 2014 · 9 comments
Closed

Documentation schemas issue #160

vtedesco opened this issue Dec 29, 2014 · 9 comments

Comments

@vtedesco
Copy link

The 3 schemas generated for this documentation page http://jmsyst.com/bundles/JMSPaymentCoreBundle/master/model look like wrong to me.

Sample :

png

@psrpinto
Copy link
Collaborator

I know it's been a while but could you please describe why you find the schemas to be wrong? What exactly is the problem? Thanks.

@vtedesco
Copy link
Author

vtedesco commented Sep 6, 2016

It's hard to read, arrow are pointing to nowhere because boxes are not properly aligned. I don't know about the data, I'm juste speaking about the visual rendering.
2cez0mbwxhlaaaaaelftksuqmcc

@psrpinto
Copy link
Collaborator

psrpinto commented Sep 6, 2016

I see what you mean, thanks for reporting it. I'm pretty sure the images were correct in the past, not sure what happened here. Will look into it.

@psrpinto psrpinto added the Bug label Sep 6, 2016
@psrpinto psrpinto changed the title Documenation schemas issue Documentation schemas issue Sep 6, 2016
@greg0ire
Copy link
Contributor

greg0ire commented Sep 6, 2016

I discovered this the other day. Maybe consider switching to it instead of versioning images? It would make contributing graphs easier.

@psrpinto
Copy link
Collaborator

Thanks @greg0ire, nomnoml looks interesting, I'll consider it when I address this issue.

@greg0ire
Copy link
Contributor

greg0ire commented Sep 10, 2016

Great! Here is the code if you decide to use that :

<script src="https://cdn.jsdelivr.net/lodash/3.7.0/lodash.min.js"></script>
<script src="http://cpettitt.github.io/project/dagre/v0.4.3/dagre.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/nomnoml/0.0.4/nomnoml.js"></script>

<canvas id="target-canvas"></canvas>
<script type="text/vnd.nomnoml.class" id="graph">
[<start>st]->[<state>new]
[new]->[<state>expired]
[expired]->[<end>end]
[new]->[<state>approving]
[approving]->[<state>canceled]
[canceled]->[end]
[approving]->[<state>approved]
[approved]->[<state>depositing]
[depositing]->[<state>deposited]
[depositing]->[<state>failed]
[failed]->[end]
[deposited]->[end]
</script>
<script>
    nomnoml.draw(
      document.getElementById('target-canvas'),
      document.getElementById('graph').innerHTML
    );
</script>

@psrpinto
Copy link
Collaborator

FYI, I decided to go with graphviz, which was the easiest way to do it. You can take look at the fixed schemas at http://jmspaymentcorebundle.readthedocs.io/en/latest/model.html

@greg0ire
Copy link
Contributor

Congrats, it looks nice! And you also get a textual representation, which is really good too!

@psrpinto
Copy link
Collaborator

Fixed by #181

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

No branches or pull requests

3 participants