Bug #3976

Update Documentation for 2.0 release

Added by Chad Berkley about 13 years ago. Updated about 12 years ago.

Target version:
Start date:
Due date:
% Done:


Estimated time:


Need to update the Getting Started Guide, the user guide and the actor reference with new 2.0 features.

Related issues

Blocks Kepler - Bug #4012: update documentation to explain adding actor to library via KARNew04/22/2009

Blocks Kepler - Bug #4070: Rework Section 1 and the GSGResolved05/18/2009

Blocks Kepler - Bug #4071: Rework Section 2Resolved05/18/2009

Blocks Kepler - Bug #4072: Rework Section 3Resolved05/18/2009

Blocks Kepler - Bug #4073: Rework Section 4Resolved05/18/2009

Blocks Kepler - Bug #4074: Rework Section 5Resolved05/18/2009

Blocks Kepler - Bug #4075: Rework Section 6Resolved05/18/2009

Blocks Kepler - Bug #4076: Rework Section 7Resolved05/18/2009

Blocks Kepler - Bug #4077: Rework Section 8Resolved05/18/2009

Blocks Kepler - Bug #4078: Rework Section 9Resolved05/18/2009

Blocks Kepler - Bug #4079: Rework Section 10Resolved05/18/2009

Blocks Kepler - Bug #4080: Rework Section 11Resolved05/18/2009

Blocks Kepler - Bug #4081: Rework Appendix BResolved05/18/2009

Blocks Kepler - Bug #4082: New user guide section on modules/module managerResolved05/18/2009

Blocks Kepler - Bug #4656: Build system needs javadocsResolved01/08/2010

Blocks Kepler - Bug #4667: New documentation on modules and extension points for modulesIn Progress01/13/2010

Blocked by Kepler - Bug #4684: Release tracking bugResolved01/21/2010

Blocks Kepler - Bug #4867: Update screenshots for the documentationResolved03/04/2010

Blocks Kepler - Bug #4868: Update R paths in documentation and demosResolved03/04/2010


#1 Updated by Chad Berkley about 13 years ago

I will take over as the editor of the documentation but will pass out various sections to others to author.

#2 Updated by Chad Berkley about 13 years ago

I finished going through all of the documentation in kepler-docs/outreach/documentation/working. I've made changes where I could and left notes about things that need to be checked up on. Several sections need to be looked at by those in charge of specific functionality. Specifically:

Section 1: Overview - minor changes - whoever makes these changes should also make changes to the GSG
Section 2: Installing and Running Kepler - probably the most work - Chad, David
Section 3: Scientific Workflows - fact/url checking
Section 4: Working with existing workflows - fact/url checking
Section 5: Building workflows with existing actors - fact/url checking
Section 6: Working with datasets - fact/url checking
Section 7: Using remote computing resources - fact/url checking
Section 8: Mathematical, Data Analysis, and Visualization packages - Mostly fact/url checking. Section 8.2 needs Ben's attention on the R details.
Section 9: Domain Specific Workflows - need specific input from Ilkay, Chad, whoever the current GEON rep is
Section 10: Glossary - just fact check. mostly nothing to do
Section 11: Writing your own actors - needs a bit of work. needs to be changed to use the build system instead of 'javac ...' - Probably Aaron, David or Chad could do this.
Appendix B: (Where appendix A is, I do not know...) - This section needs to be gone over by Ben extensively. It is all about R and RExpression workflows.

Most of my comments are along the line of "still works?" or "check url" Most sections just need to have links checked and demo workflows checked to make sure they still work. A small number of sections need to have more extensive re-writes.

I will create a bug for each of these sections and assign it to someone. If you don't feel you're the right person to do it, let me know and we can re-assign it.

#3 Updated by jianwu jianwu about 13 years ago

I will take care of <Section 7: Using remote computing resources>. One quick question: if we moved some actors (such as globus) out of Kepler 2.0 standard modules, the actors will still be introduced here and just specifying the corresponding module?

#4 Updated by Chad Berkley about 13 years ago

Thanks for volunteering, Jianwu. You've asked a good question, one that I hadn't thought of. I think we just need to say in the documentation that if the user wants this functionality, he/she needs to use the module manager to download it.

Which reminds me, we need to add a new section to the UM for modules and the module manager.

#5 Updated by Chad Berkley over 12 years ago

Assigning to Debi.

#6 Updated by debi staggs over 12 years ago

All of the screenshots and hyperlinks for the getting started guide have been updated.

#7 Updated by debi staggs over 12 years ago

Chapter One of the user's guide links and screen shots have been updated. Asking Chad to review section 1.4 Future Goals to mention the status of the development of a more modular system and new methods of configuration. We also still need someone with MatLab installed to test some of the examples.

#8 Updated by debi staggs over 12 years ago

All the screen shots have been updated and links checked. So, I think everything in the documentation is ready to go except for Chapters 11 & 12, which require some input from Aaron (Ch. 11) and David Welker (Ch. 12). Thanks !

#9 Updated by David Welker over 12 years ago

The three screenshots in Chapter 12 will have to be re-done once we have published. It should only take a few minutes and I will take care of it then. =)

#10 Updated by debi staggs about 12 years ago

Does everyone think we can close this bug now ?

#11 Updated by David Welker about 12 years ago

There are still some screen shots needed for the module manager chapter. Perhaps a good time to do those screen shots would be right after we do a mock release right before doing a real release.

#12 Updated by debi staggs about 12 years ago

Unless anyone has any objections, I am now closing this bug.

#13 Updated by Redmine Admin over 9 years ago

Original Bugzilla ID was 3976

Also available in: Atom PDF