Contrib.social

Consider merging with Content Model and Site Documentation module

Open on Drupal.org →
Created on 4 May 2025, 5 days ago

Problem/Motivation

Hi cobblestone.cosulting. I really like what you have done with this module. It leads in a similar direction to the Content Model & Site Documentation module → , but with respect to module use, yours does it in a much better way.

Similarities

  • Allows documentation of each module
  • Allows import and export of module related documentation

Differences

Content Model and Site Documentation

  • Fieldable documentation entity that is customizable to track anything. (example could add field to track related urls, or link to issues where the module was added)
  • hook_update commands to import documentation during deployment
  • Report of enabled modules with its own permission so that people that are not allowed to manage modules can still get the report. Includes links to help and documentation
  • Able to document and see many things about the site, beyond module information

Module Usage Documentation

  • Tracks install and update of modules
  • Great display within the module extend page
  • Reports can be created in Views

Proposed resolution

Consider merging this module with content_model_documentation
The lift would likely look like

  1. Renamespace the code
  2. Move the code into the module (merging services and plugins)
  3. Rewire the "notes" to reference CMDocuments (the base documentation entity)
  4. Create a hook_update_n that would migrate existing notes into CMDocuments and uninstall module_useage

Remaining tasks

Give it some thought, let me know if you are interested.

🌱 Plan
Status

Active

Version

1.1

Component

Miscellaneous

Created by

🇺🇸United States swirt Florida

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

Comments & Activities

  • Issue created by @swirt
  • Comment 5 days ago →
    🇺🇸United States mortona2k Seattle

    Hello, I suggested looking into this from the related ticket.

    I'm interested in improving the site documentation experience, to make things easier for clients and developers as projects grow over time.

    I've used both these modules a little so far.

    Module Usage Documentation is great for taking notes on why I installed a module and how it's in use. This knowledge is very valuable years later, for example, when I need to know whether it's ok to disable for the sake of a D11 upgrade, or if I should wait for compatibility.

    The tricky part is remembering to use it! I think some UI improvements could surface more info and encourage developers to fill it out.

    I used Content Model Documentation as a tool for analyzing site structure during upgrades or extension projects. I'd like to start using it from the start of projects to document things from the ground up. It seems like there is a lot here that could help out a lot, but again more UI improvements are needed to smooth out the experience.

    One quick opportunity for the combination of these modules is that the CMSD module report loads very quickly compared to the full extension page, so it would be easier to edit CMD info there.

    Thanks!

  • Comment 1 day ago →
    🇺🇸United States cobblestone.consulting

    Thanks @swirt, I am happy to consider merging our modules. I'm not sure when I'll have time to look into this, but I will do so as soon as I can.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024