Plan for URLs for core modules documentation

Created on 1 November 2016, over 8 years ago
Updated 25 March 2025, about 2 months ago

Currently documentation pages for Drupal core modules have urls "d.o/documentation/modules/[title]". Links to documentation pages using those urls are present in the Core itself. On Drupal.org these documentation pages are located all over the place, in different 'books', or different parts of the same book. All of them are listed at: https://www.drupal.org/node/1283408 .

With the new documentation system in place there are a few changes that affect this url structure:
1. All documentation pages get human-friendly urls. They are created automatically, and are based on the location of the page in the documentation section IA to ensure predictable and cohesive system of urls.
2. Documentation is split by major version, so that Drupal 7 documentation is separate from Drupal 8.
3. All documentation for core modules will be located in a single place (per version) Drupal 7/8 -> Core -> Core modules:
Drupal 8 core modules documentation https://www.drupal.org/docs/8/core/modules
Drupal 7 core modules documentation https://www.drupal.org/docs/7/core/modules

This means that, for example, documentation for core dblog module will be located at:
https://drupal.org/docs/7/core/modules/dblog for D7 version
https://drupal.org/docs/8/core/modules/dblog for D8 version

While the old urls "d.o/documentation/modules/dblog" will continue to work as redirects, they can only redirect to a single document so either D7 or D8. Which means that links from one of the versions of Core will go to the wrong version of documentation.

Next steps


  1. Status: Done, except for C below
  2. Ensure all old urls e.g. "d.o/documentation/modules/dblog" redirect to D8 version of the documentation. Even if a module is not in Core any more, still redirect to the 8 URL (which will be in the contrib section)
    Status: done, except for B below.
  3. Ensure every D8 page has relevant D7 page added as 'Related content'.
    Status: somewhat done, a 2nd pass would be good.
  4. Update urls in Drupal 8 core to link to appropriate doc guides e.g. drupal.org/docs/8/core/modules/[short-name]
    Status: Blocked on A and B below. - Work to be completed in 🐛 [META] Many documentation / handbook URLs redirect to D7 content Needs work
  5. Update urls in Drupal 7 core to link to appropriate doc guides e.g. drupal.org/docs/7/core/modules/[short-name]
    Status: Blocked on A and B below.
  6. Update URLs in Contrib documentation for modules that are in Core in some versions of Drupal and Contrib in others to point to correct URLs.

A. Currently not in the proper location:

This documentation is located outside of the central core modules area d.o/docs/8/core/modules, and thus it does not have the proper urls of the type docs/8/core/modules/X. It either needs to be moved, restructured, or redirects set.

B. Drupal 8 version needs to be created + currently not in the proper location:

This documentation only exists in D7 version, D8 version needs to be created.
Before D8 version can be created, we need to know where to put it (see below).
This documentation is located outside of the central core modules area d.o/docs/8/core/modules, and thus it does not have the proper urls of the type docs/8/core/modules/X. It either needs to be moved, restructured, or redirects set.

  • Overlay module was removed from D8

C. Not migrated:

🌱 Plan
Status

Fixed

Component

Other documentation issues

Created by

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024