Add noderef field for project to doc pages

Created on 5 March 2010, about 15 years ago
Updated 2 April 2025, 3 days ago

We need an explicit way to link a module's documentation to its related project page. In the module project page we already have a field to link to the documentation. But if you go to the documentation you won't see a link to the project page unless someone has manually created a link within the text. The link between documentation and project is a critical bit of data that should be in a separate field.

If the project page was explicitly a "related node" we could pull all sorts of useful information into a block on the handbook page like - Drupal versions supported, related modules, whether the module is deprecated etc.

This would only be needed on the parent page of the module's documentation as the child pages could inherit the information.

Perhaps in an ideal world, we wouldn't need to do create this again on the documentation side. There might be some way of capturing that relationship from what already exists in the project page. But in any case we should have, for each module's handbook content, a block that provides a link to the project page and that shows the supported versions.

wrapup of the discussion in comments:

  1. alter the type Book page, add a field "Related projects"
    1. optional, auto-complete, multi-valued
    2. description on the field :
      about the number of projects referenced being sane
      about rather not referencing core (?)
  2. place the field under taxonomy on the edit form
  3. display the project info in the yellow meta-data block in the format such as :
    "Related projects: proj_a, proj_b, proj_c"
  4. alter the view at http://drupal.org/documentation/manage
    add the field as a filter and a column, too
  5. Create a view that can show community docs pages related to a given project, and put a link saying "Related community documentation" on the project sidebar.
✨ Feature request
Status

Postponed: needs info

Component

Docs infrastructure

Created by

πŸ‡¨πŸ‡¦Canada LeeHunter

Live updates comments and jobs are added and updated live.
  • docs infrastructure

    Infrastructure/code improvements related to documentation. The Core Documentation team uses this tag.

  • Usability

    Makes Drupal easier to use. Preferred over UX, D7UX, etc.

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.

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    There hasn't been work on this for 11 years. Is there interest in pursuing this?

  • πŸ‡ΊπŸ‡ΈUnited States drumm NY, US

    I don’t think this is relevant now.

    Projects have a documentation link field which can go anywhere, since things like documentation in GitLab pages are effectively off-site.

    Documentation on Drupal.org has related content that can include projects, or any other content.

Production build 0.71.5 2024