Help test commenting on API.drupal.org

Events happening in the community are now at Drupal community events on www.drupal.org.
drumm's picture

http://d6-api.drupal.org/ is ready to test again. Notable changes are:

  • Commenting on documentation
  • Faster autocomplete in the search box
  • Search by URL, as in http://d6-api.drupal.org/theme
  • OpenSearch plugins for your browser
  • New file URLs (the old ones should redirect)
  • The parser doesn't parse \@ and links http://example.com/

With the addition of comments, we need some webmasters, please volunteer at http://drupal.org/node/547534.

Please file issues at http://drupal.org/project/issues/api

Comments

i'd love to help...

drewish's picture

but i can't seem to log in. the login or register links at the bottom of the page redirect you off to strange locations. the login link takes you to d.o and the register link does a search for user/register (which fails btw).

You may have caught it

drumm's picture

You may have caught it during a brief time when the bakery module was upgraded on drupal.org, but not d6-api.drupal.org. Everything is upgraded now. Please try again. If you can jump into #drupal-infrastructure, killes may be able to help troubleshoot.

I just tested the new

joshmiller's picture

I just tested the new functionality by typing in: http://d6-api.drupal.org/l and it took me to my favorite function's page.

I then clicked "login" -- this sort of worked. Once I logged in, it took me to the homepage of d6-api again. I expected to be taken back to function that I wanted to comment on.

Once logged in and finding the l() page again, I wrote my first api.drupal.org comment and was THRILLED. I was asked to verify a captcha, and was amazed that all of my drupal function names that I mentioned were automagically linked to their respective pages.

I feel liberated and will, for now on, only use d6-api.drupal.org

Josh

Test Comments

duellj's picture

Are you going to be flushing all of the comments made during this testing period, or will you selectively remove all test comments? Just gauging if it's appropriate to post helpful comments yet.

This is a staging site, no

drumm's picture

This is a staging site, no comments will go to the live site and everything on the staging site will be overwritten at some point.

Login

zzolo's picture

It said to login or register to post comments. When, I hit login, I was taken here: http://drupal.org/user/login , but I am already logged in there.

--
zzolo
zzolo.org

--
zzolo

Indeed...

webchick's picture

You get greeted with a nice fat "access denied" error if you have the audacity to be logged in on drupal.org first! ;)

Another problem is that /user/register ends up being aliased to http://d6-api.drupal.org/api/search/6/user/register and not actually a registration form. Oopsie. :)

The most frequently requested page in #drupal by far is the Form API reference. However, if you search for "form api" you get nothing. :( We should take the opportunity to resolve http://drupal.org/node/262690 and rename the quickstart guide and reference to use the proper term. Also, could we please index the title of the reference doc, rather than its filename, as you've done with the quickstart guide?

And finally, from a user experience perspective, it's confusing and frustrating to me how come sometimes the "login or register to post comments" isn't available on some pages (such as http://d6-api.drupal.org/api/drupal/developer--topics--forms_api_referen...) nor on overview pages such as http://api.drupal.org/api/group/hooks/6, nor on constant/filename/globals pages. On php.net, I can comment on absolutely anything, including overview pages such as http://www.php.net/manual/en/book.mysql.php. On api.drupal.org, I read a page and see something that triggers an example I just used, go to add a comment with said example, curse and spit because the links aren't there, and then I have to click around until I find some random function that's in some way tangentially related to what I want to post and hope that the next person finds it. Or I just don't bother, which is the most likely scenario.

How hard is it to expand out the commenting facility so it covers all API objects?

http://drupal.org/node/55549

drumm's picture
  • http://drupal.org/node/555490 should fix register links.
  • I'll get to renaming the form page at some point, it is not a blocker
  • The HTML parser is a bit special, I've noticed the title issue, but the regexp or whatever makes that go hasn't
  • Added comments to files and topics/groups (not deployed yet)

Are you logged into

drumm's picture

Are you logged into Drupal.org all the time? You might have managed to have a session that started before Drupal.org was adding a new cookie for bakery module. This could definitely be webchick's issue. Logging out and back in from Drupal.org should fix this.

Oh! Excellent!

webchick's picture

Yes, that was exactly my issue. I ping the "My issues" queue far too often during a day for my session to EVER time out. ;)

Login link for left block area?

calebgilbert's picture

My comments after testing:

  1. Yay!
  2. Login and logout worked well for me
  3. It would be helpful to have a login/signup link in the left block area somewhere. I see that those links appear in the comment areas, which is great, but just seems like it would be a bonus to have them on the side all the time.

I think of those login links

drumm's picture

I think of those login links as clutter, we shouldn't bother someone with logging in until they need to.

Remember, I need a volunteer

drumm's picture

Remember, I need a volunteer webmaster or two at http://drupal.org/node/547534 before this goes live. I'll look into webchick's helpful comments later today.

different login links in different places

gcassie's picture

here's my login experience:

i was already logged in at d.o, clicking the login link from api gets me the access denied page on d.o

when i logged out of d.o and logged back in there to try to get a new cookie, same result.

logged out of d.o, went back to api, and clicked the login link. got the form on d.o, submitted my creds, and was redirected to: http://d6-api.drupal.org/comment%252Freply%252F7378%252523comment-form . the login worked for both sites, though.

in all cases i was using the link inside the comment field (not the one at the very bottom of the page) of http://d6-api.drupal.org/api/function/theme/6, which i accessed by from http://d6-api.drupal.org/theme . if i use the one at the very bottom, login works fine.

looks like the login link in the comment block has a redirect argument that gets garbled going over to d.o and back. the link at the bottom of the page doesn't. i agree with earlier comments that a redirect back to the page you clicked login on is the expected behavior, so i hope there's a way to make the redirect work.

very exciting stuff. greatly looking forward to being able to comment on the api. thanks for your work on this.

Cool stuff

serbanghita's picture

Hello Neil,

Cool initiative! I had some login problems just like gcassie.

I commented on some pages and i wanted to ask if this is a normal behavior: http://d6-api.drupal.org/api/constant/DRUPAL_MINIMUM_PHP_MEMORY_LIMIT/6#... - i put a link to google with an onclick event which of course can be changed with any evil code. I guess this is one of the reasons why we need moderation.

I'll be browsing the new api web page tonight and i'll write if i find any bugs.

I would like to be a moderator and maybe come with some new feature suggestions.

Thanks!

PHP filter

boombatower's picture

Seems like having the PHP filter on would be a good thought: http://d6-api.drupal.org/api/function/db_placeholders/6#comment-18

Codefilter

webchick's picture

To be clear, that's Code filter, not PHP filter. PHP filter would be a tremendously BAD idea. ;)

Code filter would be awesome

EvanDonovan's picture

Yeah, some sort of syntax highlighting, like in the Drupal.org issue tracker would be excellent. Otherwise the code will be hard to read.

And hopefully the comments will be more helpful than the ones on PHP.net :)

One thing I hope to see: comments that link to relevant sections of the Drupal online docs. And vice versa.

Validation error

fgm@drupal.org's picture

Just logged out/logged in (after the same login/access denied problem mentioned above), and noticed that when I type a function name, like "hook_block", then click on "Search", I get "Validation error, please try again. If this error persists, please contact the site administrator." instead of being taken to the hook_block page.

Your submission has triggered the spam filter

franskuipers's picture

Was reading this trhead with being logged in on g.d.o. Went to d.o. and logged in. Came back to this page and clicked http://d6-api.drupal.org on this page.
Search gives the "Validation error, please try again. If this error persists, please contact the site administrator." error.
The site knows I am logged in, so the comment form is visible. Typed in a title and 1 sentence in the body, and got "Your submission has triggered the spam filter and will not be accepted." on save. Without a captcha.

I think I solved all issues

drumm's picture

I think I solved all issues and this is live on api.drupal.org.

api.drupal.org and API module

Group organizers

Group notifications

This group offers an RSS feed. Or subscribe to these personalized, sitewide feeds: