[Insight-developers] Migration guides docs editing

[Cory Quammen]

[snip]
> are you suggesting to make modifications directly in the
> online forum page of the migration guide ?
>
> or
>
> are you referring to modifications to be made in the XML
> file and to be pushed to git first ?

The latter (modifying the XML files). For a concrete example, please
see this gerrit patch: http://review.source.kitware.com/#change,2476.

In this patch, I opted to modify the existing XML migration guide's
code snippets (FFTUseImageAsTemplateParameter.xml) to reflect the name
change in my patch and added another for my patch
(FFTFilterRename.xml). The code snippets are essentially the same,
though, so my new migration guide document seems redundant.

Thanks in advance for your recommendations.

Cory

>    Thanks
>
>
>         Luis
>
> On Mon, Aug 15, 2011 at 10:47 AM, Cory Quammen <cquammen at cs.unc.edu> wrote:
>> I need some guidance from the migration guide team.
>>
>> Say someone makes an API change and documents it with a migration
>> guide XML document, and that this migration guide includes a snippet
>> showing how to convert old code to the new API.
>>
>> Now say I want to make a subsequent API change that invalidates the
>> original migration guide document, but it's just a name change, so
>> editing the existing migration guide document would be easy enough
>> (and seems like the right thing to do). If that's the case, do I just
>> add myself as an author to the migration guide document? Can I add a
>> gerrit-id to the <Gerrit-ChangeId> element? Do I add a date to the
>> <Date> element? Do I update the list of modified files? Or should I
>> just update the code examples and leave the rest alone?
>>
>> Thanks,
>> Cory
>>
>> --
>> Cory Quammen
>> Research Associate
>> Department of Computer Science
>> The University of North Carolina at Chapel Hill
>> _______________________________________________
>> Powered by www.kitware.com
>>
>> Visit other Kitware open-source projects at
>> http://www.kitware.com/opensource/opensource.html
>>
>> Kitware offers ITK Training Courses, for more information visit:
>> http://kitware.com/products/protraining.html
>>
>> Please keep messages on-topic and check the ITK FAQ at:
>> http://www.itk.org/Wiki/ITK_FAQ
>>
>> Follow this link to subscribe/unsubscribe:
>> http://www.itk.org/mailman/listinfo/insight-developers
>>
>



-- 
Cory Quammen
Research Associate
Department of Computer Science
The University of North Carolina at Chapel Hill