Add fieldable documentation entity

Created on 19 January 2023, over 1 year ago
Updated 8 February 2023, over 1 year ago

Problem/Motivation

As a site maintainer I want a fieldable "documentation entity" that can entity reference a content type, paragraph, taxonomy, or field so that I am able to add fields to contain the information I need.

Proposed resolution

This should avoid the simple solution of using a node bundle as then the documenation will polute the normal node content. Example "documentation entities" should not appear under /admin/content.

The unique id for the documentation entity might need to be something like entity:bundle:field

The entity should have a minimum set of fields that are default but open for adding or removing any that are not needed.
Possible default fields

  • Purpose of this ____ (long text)
  • link to external documentation
  • link to web component
  • date added

Would also be interesting if these were config entities so the content is deployable.

User interface changes

Tabs added to each of the paths identified that surface and save the fields that exist on that entity.

✨ Feature request
Status

Fixed

Version

1.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States swirt Florida

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.

  • πŸ‡ΊπŸ‡ΈUnited States swirt Florida

    Some possible approaches

    1. Configuration entity -
    + This has the pro of having the values wide with config so it exports an imports the the values can be changed along with any actual config changes.
    - The drawback is that I have not found a way to have fieldable config entities.

    2. Content entity of its own entity type so that it does not intermingle with node bundles.
    + The advantage is that it is easily fieldable.
    - Drawback it that it is not natively exportable/importable.

    3. Third party settings.
    + This is the proper use for third party settings so it makes sense to use it.
    + exports as config
    - unknown if a View can access them
    - to make it flexible/"fieldable" I think it might take a form alter (and hopefully not much more.

  • Assigned to swirt
  • πŸ‡ΊπŸ‡ΈUnited States swirt Florida
  • πŸ‡ΊπŸ‡ΈUnited States swirt Florida
  • πŸ‡ΊπŸ‡ΈUnited States swirt Florida

    I moved the pathing and tab requirement to separate issues.

    • swirt β†’ committed 35a60cac on new-cmdocument-entity
      Issue #3334959: Add fieldable documentation entity.
      
      Add related...
    • swirt β†’ committed 35a60cac on 1.0.x
      Issue #3334959: Add fieldable documentation entity.
      
      Add related...
  • Status changed to Fixed over 1 year ago
  • πŸ‡ΊπŸ‡ΈUnited States swirt Florida
  • Status changed to Fixed over 1 year ago
  • πŸ‡ΊπŸ‡ΈUnited States swirt Florida

    This has been released as part of alpha4.
    There are still a couple of known issues.

    1. Revisons are not working
    2. Some bundles in the name of the document show machine name instead of human name.
Production build 0.69.0 2024