FOSSology
Advancing open source analysis and development
Re-structure docs
Task Re-structure and update docs for the 0.8 release
Owner MikeR
Target 0.8.0

The project documentation on the website are only current to 0.6.1 and do not adequately document the new UI as of 0.7.0, or license groups as of 0.8.0. This will require updating the docs, as well as organizing them a little better for more intuitive reading.

The docs must address next release which will be 0.8.0 (bug fixes, license groups and major rewrite of documentation)

Only a minimal rewrite is required for these areas:

  • Using FOSSology from the Command Line - rando
  • Troubleshooting - danger
  • Frequently Asked Questions - danger
  • Multi-System Setup - Neal? Or Mary
    • mention NFS cross mounting amongst systems
  • Release Notes - Mary 80% done
  • 1 Introduction to FOSSology - MikeR still needs ~1hr work
    • needs cleanup, updating to incorp .7.0, .8.0
  • Videos - MikeR will re-title and write intros done
    • Is the 0.7.0 UI video out-of-date?
    • Need to re-title the videos to specifically identify content and version
  • Screenshots - DONE! - danger
    • need to add a few more to demonstrate license groups

In General - we need to re-organize the User Docs done

  • Replace “Software Repository Viewer” with “FOSSology User Interface” - MikeR ~75% done
    • 1 Provide UI overview, explain functions/tabs/ui (Mike) with links to detailed discussion/howtos (ALL)
    • 1 In particular, Browse explanation needs lots of work! - Mary & Mark (Mike will review)
    • We need to make it obvious that browsing is how you find licenses. This topic needs it’s own section. What should our approach to this information be? in general, lots of cleanup done
  • 1 Uploading a File - rando done
    • need to mention how to create a folder to put the upload in
    • update to be consistent with the instructions on the UI
  • Interpret the Job Queue - Danger (w/ Neal as consult) in-proccess
    • needs to be mostly re-written
  • Interpret the License Analysis Report - Neal done
    • most content is still valid
    • add section about license groups
 
task/re-structure_documentation_for_0.8.0.txt · Last modified: 2008/05/22 13:29 by laser

Copyright (C) 2007-2008 Hewlett-Packard Development Company, L.P.
FOSSology Project documentation is licensed under the GNU Free Documentation License Version 1.2
Recent changes RSS feed Valid XHTML 1.0 Valid CSS Driven by DokuWiki