Coming soon: faster API.drupal.org with comments

Categories:

One of the common requests for API.drupal.org is comments, like PHP has. With some help from chx, this is finally almost a reality. But I need your help; this uses a new single sign-on system and has a number of changes throughout the module.

I have been focusing on making the site faster. The auto-complete works at the speed of JavaScript, not AJAX. Short URLs, like http://api.drupal.org/hook_menu will work. OpenSearch plugins work with your browser.

If you have a few minutes, take an early look at the changes and make sure everything works before this all goes live.

Here is Drupal’s doc comment coverage:

Graph of doc comment code coverage.

Except for the lack of objects, doing relatively well, but there are a few undocumented files:

  • developer/
    • example.profile
    • examples/batch_example.install
    • examples/node_access_example.install
    • examples/nodeapi_example.install
    • examples/node_example.install
    • examples/trigger_example.module
  • includes/
    • cache.inc
    • cache-install.inc
    • database/select.inc
    • filetransfer/filetransfer.inc
    • filetransfer/ftp.inc
    • filetransfer/ssh.inc
    • form.inc
    • install.inc
    • mail.inc
    • unicode.inc
    • xmlrpcs.inc
  • install.php
  • modules/
    • aggregator/tests/aggregator_test.module
    • color/color.module
    • field/field.api.php
    • openid/xrds.inc
    • simpletest/drupal_web_test_case.php
    • simpletest/files/php-2.php
    • simpletest/tests/database_test.module
    • simpletest/tests/error_test.module
    • simpletest/tests/field_test.module
    • simpletest/tests/module_test.module
    • simpletest/tests/session_test.module
    • simpletest/tests/system_test.module
    • simpletest/tests/xmlrpc_test.module
    • system/system.tar.inc
  • profiles/
    • default/default.profile
    • expert/expert.profile
  • themes/
    • garland/block.tpl.php
    • garland/color/color.inc
    • garland/comment.tpl.php
    • garland/minnelli/color/color.inc
    • garland/node.tpl.php
    • garland/page.tpl.php
    • garland/template.php
    • seven/page.tpl.php
    • seven/template.php

Comments

I like it, it's fast indeed :p

This is *so* cool. Honestly, for anyone past the total-newbie stage this is probably one of the single best things to happen for Drupal support/documentation in a long time, maybe ever. Looking forward to contributing many (hopefully) helpful comments...

Awesome!!

Is it already live? Just tested it and it looks like it =)

Yes, soft launch.

It looks great! Thanks for the work.

Have you done a write-up on this at all, or do you intend to? I'd really like to know how you got the javascript autocomplete to be so blazing fast!

I am working on a write-up, but that part is simple: don’t use AJAX. Going to the server is incredibly slow. Our data is small enough to all fit in a single JSON download.

Post new comment

The content of this field is kept private and will not be shown publicly.
  • Web page addresses and e-mail addresses turn into links automatically.
  • Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd> <abbr> <acronym> <h3> <span> <img> <q> <blockquote> <div> <pre>
  • Lines and paragraphs break automatically.

More information about formatting options