Update D8 module builders guide

Created on 4 March 2015, about 10 years ago
Updated 20 March 2025, 21 days ago

Given D8's modern API, it follows that you will have a number of php developers working in competing CMS's that will be attracted to D8, but have no experience in D7.
I propose to update and reorganize the "Creating Drupal 8.x modules" section of the community documentation. Specifically:

1: The background and prerequisites are to intimidate. There should be friendly, welcoming language along the lines of: "These are things that you will run into while working in D8. If you are seeing them for the first time, here are resources that you can use to get up to speed." The way the page is now, it lends one to think that you need to go off and study these things before you can even get started on a hello world module. It feels more like a barrier to entry than "these are the reasons you should be excited about coming into D8".

2. The remaining sections should have a main path that walks you through creating a basic "hello world" type of module skeleton. There should be tldr sections at the top with the code samples. There should then be sub-paths that walk you through the entity, field, block, and page examples that are currently in the doc.

3. There should be a clear off-ramp at the end of each sub-path that connects it to it's corresponding examples project folder. There should be documentation on how to proceed into using the rest of the examples project's folders, how to contribute back to the examples project by converting D7 examples, helping to write documentation, etc. By providing that kind of on-ramp at the end, you can direct new Drupal module developers into working on issues and patches for the examples project. When a user becomes familiar with the process, gets used to checking their DO dashboard issue queue for updates to issues for a project, it is a very short lateral move to working on issues for the core.

Qualifications: Having just gone through this process, coming into D8 with no prior Drupal experience, over the course of the last month, I am in a good position to turn around and feed that experience back into the community documentation to make the process easier for others following behind me. I've been trying to do that anyway with editing https://www.drupal.org/developing/modules/8 , including providing a blog post with updates to the two tutorials linked to on that page. But I wouldn't want to embark on a rewrite of the entire "Creating D8 modules" section without some kind of official sanction to do so.

Thanks for any feedback you can give me on the proposed structure.

📌 Task
Status

Fixed

Component

Correction/Clarification

Created by

🇺🇸United States sidharrell

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

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