Drupal 7's @mainpage (index.php in this project) are incorrect:
- Working with the Drupal API
- Example Modules
Drupal 8's @mainpage is in core.api.php in Drupal core repository. The problems are not exactly present. In fact at present they do not exist, however there are links that are redirected on D.O hence in the future could be invalidated (ie with 9.x). Probably fine.
However, documentation project repository has an outdated index.php with @mainpage annotation. Since this is misleading/incorrect, I wonder if it should be removed?

CommentFileSizeAuthor
#6 2857775-redo-d7-landing.patch2.35 KBjhodgdon
#2 2857775-some-links-7x-1.patch742 bytesnickdickinsonwilde

Comments

NickWilde created an issue. See original summary.

nickdickinsonwilde’s picture

nickdickinsonwilde
He/Him/His
Primary language English
Location Victoria, BC (T'So-uke lands)
commented
StatusFileSize
new 2857775-some-links-7x-1.patch742 bytes

Drupal 7 patch.

nickdickinsonwilde’s picture

nickdickinsonwilde
He/Him/His
Primary language English
Location Victoria, BC (T'So-uke lands)
commented
Issue summary: View changes

Drupal 8 information updated in issue summary.

jhodgdon’s picture

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

I am not actually sure that the first change will work, in practice, on api.drupal.org. Maybe a full URL would be better? Thanks!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Regarding 8.x, I do not see the index.php file with mainpage in the 8.x-1.x branch?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs work » Needs review
StatusFileSize
new 2857775-redo-d7-landing.patch2.35 KB

Returning to this issue -- still broken on api.drupal.org. Let's see...

First off, there is nothing relevant in the D8 branch of the Documentation git repo. It's all in Core, so if there are problems with the D8 landing pages, that's a Core issue. So this issue is only for D7.

The patch above didn't apply... and I think we can do a bit better... How about this for the landing page:

/** @mainpage Developer Documentation
 * Welcome to the Drupal developer's documentation. Here are some topics to
 * get you started:
 * - @link hooks Module system (Drupal hooks) @endlink
 * - @link database Database abstraction layer @endlink
 * - @link menu Menu system @endlink
 * - @link form_api Form generation; @endlink see also the
 *   @link forms_api_reference.html Form API Reference @endlink
 * - @link file File upload system @endlink
 * - @link field Field API @endlink
 * - @link search Search system @endlink
 * - @link node_access Node access system @endlink
 * - @link themeable Theme system @endlink
 *
 * Links to additional information:
 * - @link https://www.drupal.org/project/examples Examples project, @endlink
 *   which contains sample module code useful for module developers
 * - @link https://www.drupal.org/docs/7/api Drupal API pages, @endlink with
 *   in-depth articles on many of the Drupal 7 APIs
 */

Here's a patch that would make that the landing page. Any thoughts?

nickdickinsonwilde’s picture

nickdickinsonwilde
He/Him/His
Primary language English
Location Victoria, BC (T'So-uke lands)
commented

Never actually umh noticed your initial reply. Anyways, that new patch looks nice to me +1

  • jhodgdon committed 15cd9c9 on 7.x-1.x 
    Issue #2857775 by NickWilde, jhodgdon: Some links in core @mainpage are...
jhodgdon’s picture

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

Thanks for taking a look. I have committed it. Should appear on api.drupal.org sometime soon.

Status: Fixed » Closed (fixed)

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