Commit b546f141 authored by Marco Villegas's avatar Marco Villegas
Browse files

Add an overview section on documentation with a flow diagram.

parent 05c06dbc

.gitignore

+1 −0
Changes for .gitignore: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -2,3 +2,4 @@ README.html 
codeswarm

drupal-core-git-repo

data

overview.png

Makefile

+3 −1
Changes for Makefile: 3 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -79,8 +79,10 @@ d7log: $(D7LOGS) 
d8log: $(D8LOGS)



doc: README.html

README.html: README.txt

README.html: README.txt overview.png

	asciidoc -a data-uri -a icons -a iconsdir=/etc/asciidoc/images/icons -o README.html README.txt

overview.png: overview.dot

	dot -Tpng -o overview.png overview.dot



drupal-core-git-repo:

	git clone -l --bare $(DRUPALCORE) drupal-core-git-repo

README.txt

+8 −0
Changes for README.txt: 8 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -5,6 +5,14 @@ commit history. 
It also tries to get as much as possible attribution in commit messages

as possible.



== Overview ==



The following diagram provides an overview of the flow these scripts follow to

create the results.



.Flow overview

image:overview.png["Flow overview diagram",width=128,link="overview.png"]



== About output ==



Three scenarios are analyzed: 'Drupal 8.x' (`drupal8`), 'Drupal 7.x' (`drupal7`)

overview.dot

0 → 100644
+17 −0
Changes for overview.dot: 17 added lines, 0 removed lines.
Original line number Diff line number Diff line 
strict digraph overview {

    layout=dot;

    node [fontsize=11, shape="note"];

    edge [fontsize=9,];

    a [label="git\nhistory", shape="plaintext"];

    b [label="log files\n(csv)"];

    c [label="stats files\n(csv)"];

    d [label="codeswarm files\n(xml)"];

    e [label="tagcloud files\n(tiff)"];

    f [label="codeswarm videos\n(flv, avi)"];

    a -> b [label="custom\n(python)"];

    b -> c [label="custom\n(shell, sed)"];

    c -> c [label="custom\n(egrep)"];

    c -> d [label="custom\n(awk)"];

    d -> f [label="codeswarm\n(java)"];

    c -> e [label="processing + wordookie\n(java)"];

}