Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.http://code.google.com/p/google-highly-open-participation-drupal/issues/...
Category: documentation
Proposed by: add1sun
Everyone that develops with Drupal uses the APIs and there is a great site at api.drupal.org that documents them for us. That sites runs on the API module and developers can use it to build their very own version of the API site. This is a life-saver when you don't have access to the internet or if the drupal.org site is down for some reason. There are instructions on how to set this up but they need to be reviewed to make sure they are still correct with the latest version of the module. The instructions also need to be enhanced with screenshots to make it easier for visual learners. At the end you will have your own local version of the API docs as well!
This task will involve:
* Installing Drupal 5
* Following the instructions listed in the resources to set up your own api.drupal.org site
* Make any corrections to the instructions that are needed to be successful
* Add screenshots for each configuration screen and major instruction
The task is complete once the changes to the document have been made and been reviewed by a documentation team member.
Resources:
* Your own api.drupal.org site handbook page: http://drupal.org/node/26669
* API Module: http://drupal.org/project/api
Estimated time:
2-3 days
| Comment | File | Size | Author |
|---|---|---|---|
| #7 | DAPI-final.zip | 737.17 KB | ThatPerson |
Comments
Comment #1
webchickClaimed by b.tastic (no drupal.org username found): http://code.google.com/p/google-highly-open-participation-drupal/issues/...
Comment #2
add1sun CreditAttribution: add1sun commentedFor review, here is a link to the GHOP issue comment with the files.
b.tastic this is really great! I walked through the instructions and got my API all set up. The one thing that needs to be changed is that if you don't use the optional Developer Documentation then you won't get much when you go to the API Reference link. All you will get is:
A main page for this branch has not been indexed. A documentation comment with @mainpage {title} needs to exist, or has not been indexed yet. For Drupal core, this is availiable in the developer documentation in the contributions repository.
So just make a note about that in the steps.
Also, for folks that don't have or know CVS, we should also point them to the main CVS handbook page as well as pointing them specifically to the CVS client page (http://drupal.org/handbook/cvs/clients).
Comment #3
webchickComment #4
add1sun CreditAttribution: add1sun commentedUpdated work on the Google issue needs review.
Comment #5
webchickBeen "in review" state > 24 hours. Bumping to critical. Any takers? Please?
http://code.google.com/p/google-highly-open-participation-drupal/issues/...
Comment #6
add1sun CreditAttribution: add1sun commentedThis has my changes incorporated and looks good to me. I'm marking this RTBC so docs team can incorporate these changes into the existing doc and marking the GHOP task completed.
Comment #7
ThatPerson CreditAttribution: ThatPerson commented(I'm b.tastic on Google code) Here's the project zip file.
Comment #8
add1sun CreditAttribution: add1sun commentedAwesome, thanks a lot!
Comment #9
drummThanks for the work, and sorry for not looking at this earlier.
Does this simply need to be pasted over http://drupal.org/node/26669? If so, the images do need to be scaled and cropped.
This has been improving in HEAD for Drupal 6 and the documentation will need to be updated again.
Comment #10
Sree CreditAttribution: Sree commentedLooks impressive!
images have to adjusted a bit for a better look/feel.
Comment #11
webchickGHOP is long since over, so someone else will have to do that. Moving to the documentation queue.
Comment #12
drummI did go ahead and link to the old page from the API module description. If the new content gets a new URL, please get me to update the module description or do it yourself.
Comment #13
nielsbom CreditAttribution: nielsbom commentedChanged the component to reflect the new component categorization. See http://drupal.org/node/301443
-nielsbom
Comment #14
jbrauer CreditAttribution: jbrauer commentedPer #9 and #12 updated page with new page and scaled images.