[NCBC-206] Method links anchor to awkward section of page Created: 15/Jan/13  Updated: 28/Jan/13  Resolved: 28/Jan/13

Status: Resolved
Project: Couchbase .NET client library
Component/s: docs
Affects Version/s: 1.2.0
Fix Version/s: 1.2.1

Type: Bug Priority: Major
Reporter: Perry Krug Assignee: MC Brown
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   
This link: http://www.couchbase.com/docs/couchbase-sdk-net-1.2/couchbase-sdk-net-retrieve-get.html#table-couchbase-sdk_net_executeget

Puts the anchor right on the API call, but cuts off the example above that introduces the ExecuteGet() method and the fact that it returns an IGetOperationResult. A customer would not know to scroll up a little bit.

I have a sneaky suspicion that many of the other method links are anchored in awkward positions as well and it would be great to review and fix as many as possible so they make sense to a user navigating the documentation.

 Comments   
Comment by John Zablocki [ 18/Jan/13 ]
Karen - is there an easy way to change the anchoring?
Comment by Karen Zeller [ 18/Jan/13 ]
This has to do with our XML to HTML conversion and the jump-links that it creates. This needs to go to MC.
Comment by MC Brown [ 21/Jan/13 ]
The links are automatically generated between the tables. The tables should be repositioned to be before any examples relating to their content, not afterwards.
Comment by MC Brown [ 24/Jan/13 ]
I've reposition the tables within the .NET SDK doc
Comment by Perry Krug [ 28/Jan/13 ]
I'm still seeing these anchors drop into the page below where the text related to the method begins...am I missing something?
Comment by MC Brown [ 28/Jan/13 ]
They link straight into the tables on that page, before the example, for me. Have you tried reloading?
Comment by Perry Krug [ 28/Jan/13 ]
Okay, now I see. I think the problem just "sort of" remains with the first anchor: http://www.couchbase.com/docs/couchbase-sdk-net-1.2/couchbase-sdk-net-retrieve-get.html#table-couchbase-sdk_net_get

it drops you into the page, a few lines below where the page starts. I guess it's not too big a deal, but looked to me like the problem still existed.

Is it considered at all confusing that the order of operations on the "Chapter 6" page doesn't match the order they are described on the 6.1 page?
Comment by MC Brown [ 28/Jan/13 ]
Hmm, well, the table at the head of the chapter should be sorted alphabetically (and it's not), but the latter page should order the content in terms of how they are used (there is no point discussing the CAS without the simpler get() for example.

The whole reason for the linking is that the order in the latter pages shouldn't matter because you don't have to scan for the right item - you are taken right to it.
Comment by Perry Krug [ 28/Jan/13 ]
Okay, well it seems that for multiple SDK docs, the first method is getting anchored to *after* it's introducing text...is that something we can fix?
Comment by MC Brown [ 28/Jan/13 ]
OK, post sorting fixed, now rebuilding.
Comment by MC Brown [ 28/Jan/13 ]
Fixed some additional areas where the text/tables are mismatched.
Generated at Tue May 21 19:25:21 CDT 2013 using JIRA 5.2.4#845-sha1:c9f4cc41abe72fb236945343a1f485c2c844dac9.