Details

    • Type: Task
    • Status: Closed
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.4
    • Component/s: None
    • Labels:
      None

      Description

      1. consider to include a Benchmarks chapter (TVB-1610)

      TOP SECTIONS:

      • Home, Install, Tutorials, Demos (matrix of pictures with a mark of what profile is being used), User Guide GUI, Developers

      Tutorial will have a scientific meaning (usually a workflow with a set of steps that are converging towards a scientific result)
      Demos will be shorter usually.

      We agree that we will transform all documentation in RST + ipython notebooks.

      1. OLD proposal Home, Install, Web Interface, Console Interface, Examples, Benchmarks, Developers, Experiments, GSoC, Publications

      Under "Home":

      Under "Install":

      • section technical requirements

      Under "Publications":

      • Add a chapter with official publication (Paula x2 & Marmaduke)
      • link or include the [tvb-root]/scientific_library/contrib/from_articles relevant scripts

      One "Tutorial" will be on how to prepare TVB data. it will link towards a chapter:

      • "Data Exchange" with Import/Export & Data Structure/Definition & DataSets
        Same chapter will be linked from UserGuide import page

      Under "Web Interface":

      • Tutorials from User Guide are to be removed in the near future

      Under "Tutorials":

      • reuse Node1 & Node2 handouts ...
      • inside the Handouts point to the Ladeluke share for getting the project ZIPs

      Under "Developers":

      • How to Contribute
      • GitHub link
      • TVB Architecture
      • API
      • Build & Install for Build
      • Link towards the new Paula's
      • several links towards Jira (known bugs, agile board)
      • documentation on how to add code (e.g. Analyzer, Model).
      • include [tvb-root]/scientific_library/contrib/simulator

      Old "Experiments" will go under "Developers":

      • link towards the 2nd org tvb-experiments on Github
      • link towards Jira with a new filter for "experiments"
      • mention Tim's pipeline

      old "GSoC" (will go under News on Home):

      • link towards INCF
      1. Projects accepted link (Google Melange)
      • Robert's Blog
      1. our own blog ?

      Under "Demos":

        • Pictures as links, when possible.
        • see how the HTML page metadata can be written for better google search indexes.

      When distributing TVB, the following PDF documents should be created & distributed:

      • install
      • webInterface user guide

        Attachments

          Activity

            People

            • Assignee:
              mihai.andrei Mihai Andrei
              Reporter:
              lia.domide Lia Domide
            • Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 2 weeks Original Estimate - 2 weeks
                2w
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 2 weeks, 1 day, 6 hours
                2w 1d 6h