Using Confluence 'spaces' for documentation

E.J. Zufelt everett at zufelt.ca
Wed Sep 15 20:19:06 UTC 2010


Good evening,

Having some experience using api.drupal.org can I make a suggestion.

Please make sure that you provide a textual affordance for the selected tab (version) of the api being referenced.  I cannot tell you how many times I've checked the URL to see which version is being referenced.

I know that there are other textual affordances on the page, but making the selected tab actually say selected would be great.

I'm sure that the maintainer of api.drupal.org would be willing to share a list of any publicly available modules used on the site if asked.

Thanks,
Everett Zufelt
http://zufelt.ca

Follow me on Twitter
http://twitter.com/ezufelt

View my LinkedIn Profile
http://www.linkedin.com/in/ezufelt



On 2010-09-10, at 4:15 PM, Cheetham, Anastasia wrote:

> 
> On 2010-09-10, at 2:39 PM, Wong, Harris wrote:
> 
>> Hello Anastasia,
>> 
>> Not sure if you have checked Drupal API: http://api.drupal.org/api/5
>> 
>> They have a nice way of handling different versions of documentation.  Hope it helps.
>> 
>> -harris
> 
> Thanks for the pointer, Harris. I like this - very clear. The URLs reveal an interesting point about how they version the individual pages: The version number is the *last* element of the path, so
> 
> http://api.drupal.org/api/constant/MENU_DYNAMIC_ITEM/4.7
> http://api.drupal.org/api/constant/MENU_DYNAMIC_ITEM/5
> 
> And each of these lower-level pages has a tab for the different versions, which conveys what versions this particular function is available in. Interesting...
> 
> And I'd assume that this site is implemented in Drupal, which we do have some experience in :-) Heidi and Jon, any thoughts on the idea of using Drupal for our API documentation?
> 
> -- 
> Anastasia Cheetham     Inclusive Design Research Centre
> acheetham at ocad.ca            Inclusive Design Institute
>                                        OCAD University
> 
> _______________________________________________________
> fluid-work mailing list - fluid-work at fluidproject.org
> To unsubscribe, change settings or access archives,
> see http://fluidproject.org/mailman/listinfo/fluid-work

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://fluidproject.org/pipermail/fluid-work/attachments/20100915/b1cac6bb/attachment.html>


More information about the fluid-work mailing list