For somebody new to the chart module, it appears to be quite a challenge to figure out where to get started, especially because documentation is spread over various places (outside of Drupal.org), or is simply missing.
Here are some more details about this:
The chart module is NOT included in the list of Contributed modules documentation.Refer to #2370851: Create community docu for chart for progress on this item.Moreover, the Read documentation link on the chart project page doesn't link to anywhere within drupal.org, which implies that drupal.org authorizations aren't sufficient for anybody interested in contributing to the community.Refer to #2370851: Create community docu for chart for progress on this item.- On top of that, there are 19 documentation issues in a status different from closed (fixed), about 33% of them are still in status active.
As a followup of the #2368793: Chart 2.0 'initiative' (is it OK to use that term, or anybody who has a better one?), I suggest to use this issue to address the above challenge, and also use it as a parent issue for the various existing documentation issues, as well as potentially additional (new) documentation issues being filed.
Unless I hear anything different from any of the existing chart maintainers, I'll assume they're OK with this approach. Having good documentation about what the current chart module has to offer, seems to me like a prerequisite to start addressing migrating and / or upgrading the chart module in the near future. For anybody interested in getting an idea of the kind of documentation I would like to achieve, checkout the available community documentation about forena reports, which I recently created more or less from scratch (as a new co-maintainer of the forena module also).
To be complete: any type of help / contributions from any of the existing +25K sites to address this challenge would be appreciated. Suggestions?
Comments
Comment #1
Pierre.Vriens commentedUpdate about how I plan (actually already "am" ...) using this issue as "parent issue", regarding the existing documentation issues: I've run into closed issues which for now I'm not sure if the documentation part of them have been completed addressed. E.g. some interesting docu / howto info / question included in it which for now I haven't figure out if it has been addressed (or haven't had time for yet). As a sample: #8 in #1109472: Hook chart_post_build to append custom GIC parms. Part of my goal is to work on bullet nr 3 above, especially to REDUCE such issues. On the other hand, whenever I run into docu related stuff in closed issues, I don't just want to reopen those issue, until eventually some day somebody works on such issue in the context of documentation.
Therefor, as a compromise, for now I ONLY add a parent link to such closed issues, potentially with a correction of the issue title and/or an extra comment like "has comment #x been addressed?". And whenever such issue ever gets worked on by somebody it appears appropriate to me to then reopen the issue, do what needs to be done, mark it as fixed, and then also removes the link again to this parent issue. That way by looking at the links in the parent issue, it's straight forward to answer questions (related to docu) like "what's next that I can consider working on".
This approach is the best I can think of right now, given the workflow type of features we have available on D.O ... If this approach doesn't seem appropriate, or can be further enhanced, please correct/teach me!
Comment #2
Pierre.Vriens commented