Project

General

Profile

Bug #4647

Write documentation for Reporting in the style of Kepler Docs

Added by debi staggs over 9 years ago. Updated almost 9 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
reporting
Target version:
Start date:
01/05/2010
Due date:
% Done:

0%

Estimated time:
Bugzilla-Id:
4647

Description

Write the user documentation for the WRP suite, using the same style as the rest of the Kepler documentation.

History

#1 Updated by debi staggs about 9 years ago

This documentation for the WRP suite, now renamed 'Reporting' suite is now finished.

#2 Updated by Derik Barseghian about 9 years ago

There are many errors in this documentation. It looks like my corrections and additions to the former wrp.docx (r 1249) are not included.

#3 Updated by debi staggs about 9 years ago

I would like to know what version of this you have.

Also, where in svn have you been getting your current version from ?

Originally, I believe that we had agreed that there would be separate documentation for each of the modules that made up the (previously named 'WRP', but now re-named 'Reporting' suite).

I also believe that we had discussed that the (previously named 'WRP', but now re-named 'Reporting' suite) document would be more of a general outline, that
contained links in it to each of the (more detailed) module-specific documentation.

Has this plan now changed ? Are we are merging all of the documentation for the various modules into one single document for the 'Reporting' suite documentation ?

Additionally, there should only be one error in the correct version of the documentation that I submitted, and that is based on having to use 'export archive' to be able to get the .pdf of the report. Originally, I had assumed that it would be included when the user did a 'save archive' from the file menu, but I learned yesterday that that is incorrect, and this change was not made yet in the documentation.

#4 Updated by Derik Barseghian about 9 years ago

The plan hasn't changed.

As mentioned, I made fixes and additions to wrp.docx (r1249). Afaik this doc only exists in one place: https://code.kepler-project.org/code/kepler-docs/trunk/outreach/documentation/working/modules documentation/wrp.docx

I made those changes before we deleted suite wrp and you created the new reporting docs. I would guess what happened is you created the new reporting docs off this wrp.docx, but using an older version that did not include my changes. Or maybe the new reporting docs are based off some other wrp doc that I was supposed to have changed? Regardless, I can go through the new reporting documents and remake my corrections and additions if you like.

#5 Updated by debi staggs about 9 years ago

O.K. that explains it. I had a local document that I used to create the document now currently named reporting.docx, that is in /outreach/documentation/working/modules/documentation, and I wasn't aware that you were updating the wrp document. The reporting.docx is the only current document that I have updated, and the wrp.docx is a very old version, that should be deleted.

Thank you for your offer to go through the reporting.docx document to re-merge your additions and changes there. If you would like to do that, it would be great.

As far as I am aware, the reporting.docx document should be accurate in describing the Report Designer interface and it's features, it also has a section where I had anticipated adding links to your more detailed description of the work-flow-run-manager. Other than that the only error should be on the last page where it instructs the user to use file 'Export Archive', instead of the 'Export to KAR', which still needs to be changed.

#6 Updated by Derik Barseghian about 9 years ago

I made a significant number of changes and committed to r1254 in kepler-docs, and 24536 (trunk) and r 24537 (2.0). You mention wanting to add links so I'll leave this bug open for that.

#7 Updated by debi staggs almost 9 years ago

Closing this for now, although with the disclaimer that there still may be some small changes or additions.

#8 Updated by Redmine Admin about 6 years ago

Original Bugzilla ID was 4647

Also available in: Atom PDF