Noderef field on issues for Documentation project

Created on 11 December 2010, over 14 years ago
Updated 2 April 2025, 3 days ago

Problem/Motivation

We would like to turn off comments on Documentation pages (see #810508: Kill handbook comments β†’ ). The reason is that people use comments mostly to report problems on doc pages, but it's not a manageable way for the Docs team to notice the reports and fix them.

Proposed resolution

Instead, we'd like to have:
a) A link at the bottom of each Doc page to report an issue (which would pre-fill a few fields so it prompts people to report a good issue).
b) A list of "related issues" on the sidebar of each doc page, so people could see what's being discussed about that page.

In order to do (b), we need issues to have a way to be "related" to a doc page. That is, issues need to have a nodereference so that we can say "this is an issue on this particular doc node".

Details:
1) Project issue nodes would have an optional, multiple-valued CCK noderef field, with a reference to Book pages, called "Related documentation pages". It would be displayed in a collapsed fieldset by the same name.

2) This field would be editable via comments, the same way as you can now update other issue meta-data when you add a comment.

3) This field would be settable via the URL query field when the issue is initially filed, the same way you can now for other fields (title, component, category, etc.).

4) Documentation/handbook pages on d.o will have a block view listing open issues that have been marked as related to that page. It will only be shown if there is at least one issue with a noderef to the page.

5) UI for where this appears on (a) file issue form (b) comment form to update via comments and (c) issue display is TBD.

Remaining tasks

So far, no actual work implementing this has been done.

Some implementation ideas can be found in comment #4 and #12.

User interface changes

New field on Project Issue. New block on Documentation pages.

API changes

None.

Original report by jhodgdon

We would like to have a nodereference field added to issues for the Documentation project. The idea would be that when we file issues in the Documentation project, they could be marked as to which page in the Handbook they pertain to.

Once that has been added, we would want the automatic issue filing link from
#810508: Kill handbook comments β†’
to automatically fill in that field with the correct noderef.

Also, we would want to display a block on each Handbook page of the issues that have been filed against that particular page.

✨ Feature request
Status

Postponed: needs info

Component

Docs infrastructure

Created by

πŸ‡ΊπŸ‡ΈUnited States jhodgdon Spokane, WA, USA

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.

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

    Is there interest in pursuing the changes here?

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

    I don’t think so. It looks like a key part of the plan was to add a field to issues. That is not doable with GitLab, which does not have arbitrary fielded data.

Production build 0.71.5 2024