It would be nice if we had links from the API site back to documentation:

- link http://api.drupal.org/api/drupal to http://drupal.org/developing/api
- link topics back to subpages of http://drupal.org/developing/api

I see that http://api.drupal.org/api/drupal/includes!database!database.inc/group/da... has a link to http://drupal.org/developing/api/database, but it's buried at the bottom and isn't formatted correctly.

CommentFileSizeAuthor
#3 documentation-add-link-to-api-doc-1750442-3.patch424 bytesUnitoch

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Project: Drupal.org infrastructure » Documentation
Component: api.drupal.org » API documentation files

The first link seems like a good idea. That can be added to the index.php file in the Documentation project's git repository, which generates the Drupal landing pages (would need to be added to 6.x, 7.x, 8.x branches), and that's in subdirectory "developer".

The second one is not possible to do in a systematic way. Hopefully most topics have links, but for ones that don't, you can patch the core docs.

So this should not be an "infrastructure" issue... it should be made into specific issues for the specific places that need patches. For the moment, moving to the Documentation project to take care of the first suggested link.

joachim’s picture

joachim commented

Ok. For the DB API link, filed #1751612: badly formatted @link in Database docs. I'll file for the others when I spot them.

Unitoch’s picture

Unitoch commented
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new documentation-add-link-to-api-doc-1750442-3.patch424 bytes

The Drupal 8 doc already had a link back to https://drupal.org/developing/api/8

Here's a patch for the 7.x-1.x branch

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Fixed

Good idea. Agreed 8.x is fixed. Thanks for the 7.x patch! Committed to the 7.x-1.x branch.

  • jhodgdon committed 06d3788 on 7.x-1.x authored by Unitoch 
    Issue #1750442 by Unitoch: links from api.d.o back to documentation
joachim’s picture

joachim commented
Status: Fixed » Needs work 
+++ b/developer/index.php
@@ -23,4 +23,6 @@
+ *   - @link /developing/api Working with the Drupal API @endlink

A relative link doesn't work here, because it's a different subdomain: https://api.drupal.org/developing/api is a 404.

And also, the API module can be run by anyone, anywhere.

  • jhodgdon committed cd7697c on 7.x-1.x 
    Issue #1750442: Fix typo in link URL
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs work » Fixed

Doh. Fixed that directly (it's a contrib repository so a bit more informal procedures can apply). Thanks for checking joachim!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.