New API Docs for 6.3
Created skeleton for new API document in SVN, updated with beta requirements.
From BZ#1104796: Title: Limitations of Map Methods Describe the issue: ISPN-761 (an undocumented major API change in JDG 6.2) changed the way the size(), values(), keySet() and entrySet() calls work. These now include entries in the cache store by default, which can have a *huge* impact on performance.
Tristan, any ETA on the final diff for new, changed and removed packages for the API Docs?
Created attachment 913768 [details] API diffs
Additional requirement: Add C# docs into the API Docs wrapper. Misha is looking into this now.
I'll set this to ON_QA once we have the final version of the api docs for all three in this. For now, Martin, could I ask you to verify the package addition and changes listed please.
I checked the docs and have a few comments: * change "Red hat JBoss Data Grid Javadocs" to "Red Hat JBoss Data Grid Javadocs" * for the C++ docs we can include just the first sentence (including the one link): "Click the link to view the Red Hat JBoss Data Grid C++ Hot Rod Client documentation." The rest is IMO redundant. * for the C# client documentation I'd use the same approach as described above for C++, the other links are available through the root link and are redundant. Since JDG 6.2.1, only these packages have been added: * org.infinispan.objectfilter * org.infinispan.persistence.jpa * org.infinispan.persistence.jpa.configuration I think we did not remove any packages. Regarding changed packages, this information is hard to get and if we really want it, it's up to engineering to provide it. Personally, I don't think this information is useful. We keep backward compatibility and so this list of changed packages does not make much sense. I'll wait for the final version including docs for CR2.
Thanks, Martin. Comments inline: (In reply to Martin Gencur from comment #14) > I checked the docs and have a few comments: > > * change "Red hat JBoss Data Grid Javadocs" to "Red Hat JBoss Data Grid > Javadocs" Fixed. > * for the C++ docs we can include just the first sentence (including the one > link): > "Click the link to view the Red Hat JBoss Data Grid C++ Hot Rod Client > documentation." > > The rest is IMO redundant. Sure. I added those initially because the main page is a little empty. Reverted to just the main link now. > * for the C# client documentation I'd use the same approach as described > above for C++, the other links are available through the root link and are > redundant. Done, same as C++ > Since JDG 6.2.1, only these packages have been added: > > * org.infinispan.objectfilter > * org.infinispan.persistence.jpa > * org.infinispan.persistence.jpa.configuration Hm, so none of these were in the diff from Tristan. I'm not sure which list we should have here for new packages. Tristan, can you help clarify this please? > I think we did not remove any packages. > Regarding changed packages, this information is hard to get and if we really > want it, it's up to engineering to provide it. Personally, > I don't think this information is useful. We keep backward compatibility and > so this list of changed packages does not make much sense. OK. Tristan, do you also agree that the list of changed packages is not very useful? If we have an agreement, I'll just get rid of it. > I'll wait for the final version including docs for CR2. I'll flag you for QA when we have the final api docs included. Thanks, Martin!
Yes, get rid of the package diff.
Sorry, you're right, added packages are important, changed packages can be removed
Thanks, Tristan. I'll remove those then. However, we still seem to have two different sets of new packages: those from your diff, which are now in the API Docs staged at the moment and the ones Martin has identified in comment #14. I'd like your input on which one is the more accurate one since there doesn't seem to be any overlap, which is rather odd.
Just to clarify how I got the package set. I opened API docs for 6.2.1 and 6.3 side-by-side and looked which packages have been added. The org.infinispan.commons was already there in 6.2.1 so this is not new.
So is Tristan already on PTO from today? If so, is there anyone else who can clarify which added packages list we should go with, or if we should just amalgamate the two we have, or drop this information altogether till later?
CR2 is out, updating all three api docs and publishing shortly.
Clarified new packages list with Martin and now changing it to the list in comment #14. Link soon.
Time for me to head off, so the updated api docs should be available shortly (within the next hour) at the same link as in comment #23. I'm setting this to ON_QA since Martin's team is currently testing CR2. Assuming the api docs included in that package are OK, we should be OK with this bug as well.
org.infinispan.security package will need to be added as a new package. We will also need to update the link to the JavaDocs after CR3 is released.
* Added org.infinispan.security to list of new packages. Waiting for CR3 to update all api docs within the wrapper. Setting to POST till CR3 is out.
Updated with CR3 api docs, hot rod docs. Publishing to stage. I'll post the review link here when it is available.
This looks OK to me.
Now available on access.redhat.com under the JBoss Data Grid 6.3 documentation label.