rultor
rultor copied to clipboard
yegor256
Incomplete documentation - architecture overview
While the current documentation has a number of articles on how to set up rultor, it is lacking in the developer's department. While there is a section on how to contribute to the project, it only mentions technicalities, in essence being a "your code must be this good to be included" statement.
I think that at least architecture overview is in order, preferably with a data flow and control flow diagrams included.
@maurezen many thanks, 15 mins added to your acc for reporting this bug, pmt ID 50597261
@alex-palevsky please assign someone else. I think my English is too bad.
@alevohin all right, we'll find someone else for this task
@alex-palevsky assign me to this pls
@yegor256 OK, the task is yours, go ahead
@alex-palevsky please assign to someone else
@adko-pl all right, we'll find someone else for this task
@maurezen I added milestone 0.3 to this issue, let me know if there has to be something else
@alex-palevsky Please assign to someone else. I cannot do this task with acceptable quality.
@alex-palevsky Please assign to someone else. I cannot do this task with acceptable quality.
@xupyprmv -30 points to your rating :(
@alex-palevsky Please assign to someone else. I cannot do this task with acceptable quality.
@xupyprmv someone else will help in this task, no problem at all
@alex-palevsky this one is postponed
@yegor256 got it, "postponed" label here
@alex-palevsky this one is postponed
@yegor256 no problem, I will try to find somebody else
@maurezen I find data flow diagrams (https://www.google.com/search?q=data+flow+diagram&tbm=isch) to be rather excessive and dificult to make sense out of, but that's only my personal opinion. And correct me if I'm wrong, but aren't control flow diagrams (https://www.google.com/search?q=control+flow+diagram&tbm=isch) used to describe algorithms rather than architectural overviews?
That said there is a link to a talk on Rultor architecture in the README.md. If this is not enough, perhaps the following diagrams could be added:
-
"architectural overview diagram" (for the high level overview of the system) -
https://www.google.com/search?q=UML+architectural+overview+diagram&tbm=ischMaybe a combination of use case diagrams (https://www.google.com/search?q=use+case+diagram&tbm=isch) and component diagrams (https://www.google.com/search?q=component+diagram&tbm=isch), linking actors to components? - sequence diagrams (for ilustrating what happens on merge, deploy and release events; maybe one would be enough) - https://www.google.com/search?q=sequence+diagram&tbm=isch
