Absolutely, this is the sort of documentation I'm planning to add.

On Tuesday, August 25, 2015 at 10:51:08 AM UTC+1, Robert Sandell wrote:
>
> It would be great if someone could write up a small migration guide on the 
> wiki for plugin devs that are upgrading their core dependency.
>
> Something like "Where you used to do 
> f.getButtonByCaption("Advanced...").click(); 
> change to HtmlFormUtil.getButtonByCaption(f, "Advanced...").click();" etc.
>
> On Tue, Aug 25, 2015 at 11:39 AM, Antonio Muñiz <[email protected] 
> <javascript:>> wrote:
>
>> I think a README.md behind the code would be ok, since this project is 
>> used mainly by developers.
>>
>> On Tue, Aug 25, 2015 at 11:25 AM, Tom Fennelly <[email protected] 
>> <javascript:>> wrote:
>>
>>> I eventually got rid of the forked version of HtmlUnit from Jenkins 
>>> core in this PR <https://github.com/jenkinsci/jenkins/pull/1774>. Also see 
>>> governance meeting notes on same 
>>> <https://wiki.jenkins-ci.org/display/JENKINS/Governance+Meeting+Agenda#GovernanceMeetingAgenda-Aug19meeting>.
>>>  
>>> This should result in us being able to use more modern JS libs in Jenkins + 
>>> write tests against them that don't blow up in our face.
>>>
>>> Our forked version of HtmlUnit had inlined API extensions that no longer 
>>> exist. I replaced all of these with static utility methods (in DomNodeUtil, 
>>> HtmlFormUtil etc). I need to document these somewhere (also need to add 
>>> more Javadoc as part of the PR). Where would be best? I could put a 
>>> README.md in beside this code?
>>>
>>> -- 
>>> You received this message because you are subscribed to the Google 
>>> Groups "Jenkins Developers" group.
>>> To unsubscribe from this group and stop receiving emails from it, send 
>>> an email to [email protected] <javascript:>.
>>> To view this discussion on the web visit 
>>> https://groups.google.com/d/msgid/jenkinsci-dev/4a0b5562-107e-4c68-a253-98ff2d830e7f%40googlegroups.com
>>>  
>>> <https://groups.google.com/d/msgid/jenkinsci-dev/4a0b5562-107e-4c68-a253-98ff2d830e7f%40googlegroups.com?utm_medium=email&utm_source=footer>
>>> .
>>>
>>> For more options, visit https://groups.google.com/d/optout.
>>>
>>
>>
>>
>> -- 
>> Antonio Muñiz
>> Software Engineer
>> CloudBees, Inc.
>>
>> -- 
>> You received this message because you are subscribed to the Google Groups 
>> "Jenkins Developers" group.
>> To unsubscribe from this group and stop receiving emails from it, send an 
>> email to [email protected] <javascript:>.
>> To view this discussion on the web visit 
>> https://groups.google.com/d/msgid/jenkinsci-dev/CAJc7kzQqhBv2oDwdr6qWSv59oZJHwvpt0AVHUzksg-cGhFui0A%40mail.gmail.com
>>  
>> <https://groups.google.com/d/msgid/jenkinsci-dev/CAJc7kzQqhBv2oDwdr6qWSv59oZJHwvpt0AVHUzksg-cGhFui0A%40mail.gmail.com?utm_medium=email&utm_source=footer>
>> .
>>
>> For more options, visit https://groups.google.com/d/optout.
>>
>
>
>
> -- 
> Robert Sandell
> *Software Engineer*
> *CloudBees Inc.*
>

-- 
You received this message because you are subscribed to the Google Groups 
"Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/jenkinsci-dev/c1a7455e-4b21-493d-bb6b-fd1406a0c6c0%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to