Docs Sprint Planning

Docs Sprint Planning



JIRA Documentation issues for 1.5
http://issues.fluidproject.org/issues/?filter=10360

 

IoC Docs

Topic

Who

Status

Topic

Who

Status

 Why Inversion of Control

  • flesh out to give more explanation

  • update code samples to latest form

  • remove anything without 'autoInit'  

    Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

  • remove mention of lifecycle functions

    Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

  • remove mention of initDependents

    Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

 

 

Remove mention of demands 

Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

We've decided that demands blocks will no longer be used or recommended, so we will remove references to them altogether. They should be replaced with either the use of distributeOptions, or with a grade that overrides things.

 

In progress

The two pages have been removed. The rest of the docs still need to be reviewed.

Invokers        

Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

fast invokers, dynamic invokers, compact syntax

Justin,

Antranig to review

Done

Component Grade page Component Grades    

Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

    combining grades
    creating your own grades

- and then cover dynamic grades, both supplied via direct options as well as those resolved
via an IoC reference in the "gradeNames" list - explain the limitations on this latter process
and how it must be used carefully.

dynamic grades and grade merging
   ability to write an ioc expression where a grade name is expected

See

Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.
for notes that might be helpful.

Antranig to review

Needs Review

 Model Transformation   

Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

    update to reflect latest code
        transforms now in "fluid.transforms" namespace
        many new transforms available (see ModelTransformationTransforms.js)
        transforms now specified with "transform:" instead of "expander:"

Some docs exist in the GPII wiki:
http://wiki.gpii.net/index.php/Architecture_-_Available_transformation_functions

Cindy

In progress

the ginger process, why it's useful 


rename it! explain it somewhere where appropriate

 

 

Michelle

In Progress

Each child page of IoC - Inversion of Control
    ensure any code samples reflect current APIs, practices, features, etc
    ensure text reflects current framework
    add new features where appropriate

 

 

  • How to Use Infusion IoC Needs to be reviewed and brought up-to-date to reflect current best practices (e.g. no demands, IoCSS, etc)

 

 

Colin

 

  • Contexts   

    • diagram from demand resolution page, plus some explanation

Anastasia

In progress

  • Pseudoarguments

    • "a demands block which uses named arguments such as "options", "container", etc. rather than an argument list"

 

 

Message loading: We need an overview page describing how to work with message files/string bundles, for localization, including

  • in renderer components

  • using the message resolver (fluid.messageResolver) in non-renderer-component scenarios

 

 

  • Update the scenarios, use to identify "paths through the docs"

Anastasia

not started

Overview of IoC and its goals (on this page? IoC - Inversion of Control), including   


    configuration only
        declarative listeners
        declarative prototrees
        declarative invokers and events

 

 

Component authoring process from the perspective of 2nd parties, 3rd parties, etc.  


convey the fact that you're developing something that might be used by future authors
What are the mechanisms by which an author would make an application reconfigurable?