Problem/Motivation

Great work was done to outline general 'Getting Started with Decoupled Drupal' documentation here: https://www.drupal.org/docs/contributed-modules/decoupled-menus-initiative, but as we attempt to complete this phase of the initiative, the scope of this is problematic. We should re-focus this documentation on things that are specific to decoupled menus, while ensuring that this more general decoupled Drupal content lives on and has a new home.

Proposed resolution

We'll revise the documentation to be focused on decoupled menus. Initial draft was created here: https://docs.google.com/document/d/1s-yvfTeTHj0XoT23h4BSuXhbjNZ3l4oz4iy7...

Remaining tasks

* Revise existing documentation to focus on decoupled menus.
* Define a clear path to migrating the 'guide to decoupled Drupal' content to a new home.

Comments

brianperry created an issue. See original summary.

brianperry credited AaronMcHale.

brianperry credited rlnorthcutt.

brianperry’s picture

brianperry
he/him
commented
Issue tags: +FLDC2022

I've provided some additional comments and revisions within the google doc.

Also credited others who have provided earlier review.

vee.vopham’s picture

vee.vopham commented

Hi!

See below for some thoughts/initial feedback I had after giving this a review, and please note, I'm not a dev or have technical knowledge of this topic. But I did add the below notes with inclusion front of mind, and I was also thinking through ways we can make the documentation more accessible to all audiences, including non-devs.

  • I would add a more direct definition of Decoupled Menus right in the beginning of the doc (like how do you decouple a menu/what it looks like), and maybe, a real-world example would be helpful. And to add on this, I feel like a brief overview of Decoupled Drupal would be helpful. So, you'd briefly discuss what Decoupled Drupal is, what Decoupled Menus are, and then why they matter.
  • I also feel like the beginning section could be expanded upon a tad and maybe include defined sub-sections for 1) the benefit/use case of Decoupled Menus for developers and 2) the benefit/use case of Decoupled Menus for non-developers (which could fall under one heading for 'The benefits/value of Decoupled Menus). Being someone who doesn't have deep knowledge of Decoupled Menus/Decoupled Drupal, I came to this doc wondering, "why does this matter? what's their use case especially for non-developers?" And the section that starts with "While this functionality can be used in many ways, there are two primary use cases that Decoupled Menus is serving:" could be under a section for the benefits/use case for developers?
  • Should some of the acronyms be defined when they're first mentioned, e.g., Node Package Manager (NPM) and Content Delivery Network (CDN)?
eojthebrave’s picture

eojthebrave
he/him
Primary language English
Location Minneapolis, MN
commented

FYI. I did a little reorganizing of things to make the decoupled menus page a guide so we can add sub-pages. And then created an "API usage" page in that from the content of the linked google doc. Someone could do the same with the "components and libraries" content as well.

https://www.drupal.org/docs/develop/decoupled-drupal/decoupled-menus