Update Documentation for 2.0 release
Need to update the Getting Started Guide, the user guide and the actor reference with new 2.0 features.
#2 Updated by Chad Berkley over 10 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.
#4 Updated by Chad Berkley over 10 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.
#7 Updated by debi staggs almost 10 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.