Problem/Motivation

How do we get started with decoupled Drupal? (the "how to" part of the documentation )

Steps to reproduce

Proposed resolution

we could take the format of https://documentation.divio.com and have:

Start a doc that explains how to get started.

Remaining tasks

User interface changes

API changes

Data model changes

Comments

nod_ created an issue. See original summary.

nod_’s picture

nod_
Primary language French
Location Lille
commented
Title: Produce a starting technical documentation » Start an end-user-friendly technical documentation
eojthebrave’s picture

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

I would like to help out with this effort, but it's a bit vague at the moment. Is this ready to be worked on? And if so what can I do to help move things forward? I'm happy to work on filling out the issue summary more if you can point me towards any existing documents. And/or whatever else makes sense.

Also as a point of clarification, is this to document getting started with this initiative? Or getting started with decoupled Drupal in a broader sense like for a developer building a client site?

nod_’s picture

nod_
Primary language French
Location Lille
commented
Issue summary: View changes

I don't think it's ready yet, there are a lot of decisions up in the air that we'd need to make before documenting things.

On the other hand we can start polishing the documentation we already have: https://www.drupal.org/docs/core-modules-and-themes/core-modules/jsonapi... (for the "explanation" part of the doc)

baddysonja’s picture

baddysonja
Primary language Icelandic
Location Frankfurt am Main
commented
Issue tags: +decoupledDCNA2021

We started a Google Doc that later can turn into the documentation on drupal.org. This document is editable for anyone (no access needed).

We can start asking the most relevant questions and then later start answering them in the document.
When we have the answers, we can start thinking about where to put this on d.o.

Link to a Google Doc

baddysonja’s picture

baddysonja
Primary language Icelandic
Location Frankfurt am Main
commented

There is another issue for a FAQ: https://www.drupal.org/project/decoupled_menus_initiative/issues/3181747

We should merge things from this issue into our document.

Link to google doc

nod_’s picture

nod_
Primary language French
Location Lille
commented

got the structure set up over at https://www.drupal.org/docs/contributed-modules/decoupled-menus-initiative

Copy pasted the relevant portion of the drupalcon google doc: https://docs.google.com/document/d/11BRyMbzW2-6S_0usuKH8O8-Dnw2RV9n0GMSI...

nod_’s picture

nod_
Primary language French
Location Lille
commented

This is not going to be the "curated" final version of the documentation, it is a playground to figure out what the content/structure should be before we add all the code snippets and developer oriented content/features to the documentation. Kind of similar to the mobile guide that was created back for D7: https://www.drupal.org/docs/7/mobile

ishanmahajan’s picture

ishanmahajan commented

Hi All, there is a comment in the Google doc about possibly including a reference to EzContent for the ability to use the layout builder. I have added my thoughts in the document.

The EzContent team will be happy to provide any additional information or do a demo/walkthrough of the implementation to the maintainers of this documentation.

I think it will be great to include the layout builder integration in the documentation. This is one of the features that differentiates Drupal from some of the other pure headless CMSs out there.