Yes, and as we're already heavy users of Sphinx (we even use its Click plugin to generate CLI documentation), it would be wonderful if we could include the visuals there, too.
Anyway, need to start somewhere. Many thanks, Vish. :) On Wed, Oct 18, 2017 at 3:58 PM, Thomas Nadeau <[email protected]> wrote: > > Yes, but I think Vish was looking for something more > visual/graphical. It looks like there > are easy ways to generate UML diagrams w/ Sphinx: > > http://build-me-the-docs-please.readthedocs.io/en/latest/Using_Sphinx/ > UsingGraphicsAndDiagramsInSphinx.html > > —Tom > > > > On Oct 18, 2017, at 4:55 PM, Tal Liron <[email protected]> wrote: > > > > Just to make sure -- you guys are aware of our detailed API > documentation, > > generated by Sphinx? > > > > http://ariatosca.incubator.apache.org/docs/html/index.html > > > > On Wed, Oct 18, 2017 at 3:04 PM, Vishwanath Jayaraman < > > [email protected]> wrote: > > > >> Oh ok, thanks for sharing. > >> > >> > >> Vish > >> > >> > >> ------------------------------ > >> *From:* Thomas Nadeau <[email protected]> > >> *Sent:* Wednesday, October 18, 2017 3:00 PM > >> > >> *To:* [email protected] > >> *Subject:* Re: High level design documentation or class/sequence > diagrams? > >> > >> > >> Instead of wrestling with the licensing/etc… as well as doing this by > >> hand, let me suggest trying pyreverse which comes with the pylint > package. > >> You do have to feed it individual .py files, but it will create a UML > >> formatted .png output of python classes. One thing we could do is add > this > >> to > >> the makefile so that you can do this from the top level and auto-get all > >> of these files as you go. > >> > >> I just tried this on aria/core.py: > >> > >> tnadeau@ariatosca-dev:~/git/incubator-ariatosca/aria$ pyreverse core.py > >> -o png -p core > >> parsing core.py... > >> tnadeau@ariatosca-dev:~/git/incubator-ariatosca/aria$ ls > >> classes_core.png core.py extension.py logger.py orchestrator > >> storage > >> cli exceptions.py __init__.py modeling parser > >> utils > >> tnadeau@ariatosca-dev:~/git/incubator-ariatosca/aria$ > >> > >> > >> > >> > >> There is also apparently a plug-in for Eclipse for this sort of thing > too. > >> > >> —Tom > >> > >> > >> > >> On Oct 18, 2017, at 3:33 PM, Vishwanath Jayaraman < > [email protected]> > >> wrote: > >> > >> You probably still need an activation license for the community edition > >> (see https://knowhow.visual-paradigm.com/license-key-2/register-ce/). > >> > >> If you apply the activation license, I am guessing the watermark on the > >> outputs may go away I presume. > >> > >> How to Register your Visual Paradigm Community Edition ...< > >> https://knowhow.visual-paradigm.com/license-key-2/register-ce/> > >> knowhow.visual-paradigm.com > >> Visual Paradigm Community Edition is a FREE UML drawing tool for you to > >> create professional-look UML diagrams easily and quickly thought its > >> award-winning diagramming ... > >> > >> > >> > >> > >> Vish > >> > >> > >> ________________________________ > >> From: Thomas Nadeau <[email protected]> > >> Sent: Wednesday, October 18, 2017 2:28 PM > >> To: [email protected] > >> Subject: Re: High level design documentation or class/sequence diagrams? > >> > >> > >> Vish, > >> > >> Thanks for taking the initiative to start this up. This is > >> fantastic. > >> > >> Question about Visual Paradigm as a tool. When it comes up, it is > >> only run in “community edition” without a license and watermarks all of > the > >> output. Is there a way to get a community edition license for us > (Apache > >> and/or just the Aria project) to use ? > >> > >> —Tom > >> > >> > >> On Oct 18, 2017, at 3:22 PM, Vishwanath Jayaraman < > [email protected]> > >> wrote: > >> > >> FYI For my own reference later and coming upto speed, I have initiated > >> creating package diagrams, class diagrams now using Visual paradigm > 12.0 ( > >> https://www.visual-paradigm.com/download/community.jsp), find link to > the > >> ARIA.VPP file that is still work in progress at https://github.com/ > >> vishwanathj/ARIA/blob/master/ARIA.vpp . > >> > >> [https://avatars2.githubusercontent.com/u/7134678?s=400&v=4]<https:// > >> github.com/vishwanathj/ARIA/blob/master/ARIA.vpp> > >> > >> vishwanathj/ARIA<https://github.com/vishwanathj/ARIA/ > blob/master/ARIA.vpp> > >> github.com > >> Contribute to ARIA development by creating an account on GitHub. > >> > >> > >> Download Visual Paradigm Community Edition<https://www.visual- > >> paradigm.com/download/community.jsp> > >> www.visual-paradigm.com > >> Get it FREE today - UML + SysML + ERD software. No risk and no > obligation. > >> One stop shop for UML Diagrams, SysML Diagram and ERD. Run on Windows, > Mac > >> OS X and Linux. > >> > >> > >> > >> > >> [https://avatars2.githubusercontent.com/u/7134678?s=400&v=4]<https:// > >> github.com/vishwanathj/ARIA/blob/master/ARIA.vpp> > >> > >> vishwanathj/ARIA<https://github.com/vishwanathj/ARIA/ > blob/master/ARIA.vpp> > >> > >> [https://avatars2.githubusercontent.com/u/7134678?s=400&v=4]<https:// > >> github.com/vishwanathj/ARIA/blob/master/ARIA.vpp> > >> > >> vishwanathj/ARIA<https://github.com/vishwanathj/ARIA/ > blob/master/ARIA.vpp> > >> github.com > >> Contribute to ARIA development by creating an account on GitHub. > >> > >> > >> > >> github.com > >> Contribute to ARIA development by creating an account on GitHub. > >> > >> > >> > >> I will add sequence diagrams later after Tal has gone through his video > >> session. > >> > >> Thanks > >> > >> -Vish > >> > >> > >> > >> Vish > >> > >> > >> ________________________________ > >> From: Thomas Nadeau <[email protected]> > >> Sent: Tuesday, October 17, 2017 1:44 PM > >> To: [email protected] > >> Subject: Re: High level design documentation or class/sequence diagrams? > >> > >> > >> That was the plan (as well as a link from the Getting Started/Dev > >> resource area). 8) > >> > >> —Tom > >> > >> On Oct 17, 2017, at 8:49 AM, Arthur Berezin <[email protected]> wrote: > >> > >> Tal, I think it would be worth having this recorded and available on > >> YouTube. > >> > >> On Thu, Oct 12, 2017 at 9:16 PM Vishwanath Jayaraman < > >> [email protected]> wrote: > >> > >> Sounds good > >> > >> Sent from my iPhone > >> > >> On Oct 12, 2017, at 1:14 PM, Tal Liron <[email protected]<mailto: > >> [email protected]>> wrote: > >> > >> There is none. However, I am planning to do a live video session where > we > >> do an overview of the codebase. > >> > >> On Thu, Oct 12, 2017 at 12:59 PM, Vishwanath Jayaraman < > >> [email protected]<mailto:[email protected]>> wrote: > >> > >> Was wondering if there are any high level design documentation or > >> class/sequence diagrams that could help someone new(as a contributor) > >> joining the ARIA project get a high level understanding that would help > >> come upto speed? > >> > >> If there is not such artifacts already, I was thinking of generating > them > >> as I start contributing to the project, hence the above question. > >> > >> Thanks > >> > >> Vish > >> > >> > >> > >> > >> > >> > >
