Add information about using DDEV for local development

Created on 19 August 2024, 9 months ago

Documentation location/URL

We could add a recommendation to use DDEV for local development in the User Guide.

Would it make sense to add it as a new "3.1" item, squeezing it in right before "Concept: Server Requirements" like this? (changing "3.1 Concept: Server Requirements" to "3.2")

  • 3.1 Concept: Local development
  • 3.2 Concept: Server Requirements

https://www.drupal.org/docs/user_guide/en/installation-chapter.html β†’

Problem/Motivation

Since DDEV is now the recommended local development tool, it would be nice to highlight this in the User Guide.

Proposed resolution

Add the content from https://www.drupal.org/docs/official_docs/local-development-guide β†’ in the User Guide, as a new "3.1 Concept: Local development" chapter.

Remaining tasks

πŸ“Œ Task
Status

Active

Version

11.0

Component

User Guide content

Created by

πŸ‡©πŸ‡°Denmark ressa Copenhagen

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

Merge Requests

Comments & Activities

  • Issue created by @ressa
  • First commit to issue fork.
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    I think recommending DDEV in the User Guide is a good idea. We've already got a page on local development environments here https://www.drupal.org/docs/user_guide/en/install-dev-making.html β†’ .

    In my update I added a new page with details about using DDEV. Then reordered the pages in the chapter so that the "Preparing to Install" will be first now, and provides a sort of check list for things you'll need to do and decisions you'll need to make. As well as recommending that if you're unsure, or just want to get started quick, you should use DDEV.

    Then I also updated the other tutorials in this chapter, and the one in chapter 11 about development environments, with information about using DDEV.

    My hope is that this helps people who are unsure, or don't care, about where to start by pointing them to DDEV. While still providing enough generic information for people who are using something else so that they can figure things out.

  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    Thanks for the updates, those are great changes, making the user aware of the recommended dev tool.

    I wanted to check the changes in an actual PDF, and tried but failed to generate a PDF. So I created an issue on how to get DDEV ready to do this. As soon as that's ready, I'll review this issue.

    On another side note, I saw that some links use http://, like http://redcrackle.com/ and these links could be updated to use https:// -- in fact this could even be an issue in itself -- so I created one :)

  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    I managed to get a PDF generated, and your updates, reordering and additions are perfect, beyond my expectations. You goals about guiding new uncertain users in the right direction have certainly been met, so thanks for making this improvement!

    Just a single comment about "Quickstart", and then it should be good to go.

    I thought about stating even more explicitly that Composer is included in DDEV, but this sentence is probably enough to convey that:

    Set up a local development environment using DDEV to serve the application and Composer to download the required files.

  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN
  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    Thanks! This looks great, and it is ready.

  • Pipeline finished with Skipped
    about 1 month ago
    #470438
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN
  • πŸ‡ΊπŸ‡ΈUnited States Amber Himes Matz Portland, OR USA

    Just some minor grammatical issues:

    1. source/en/install-ddev.asciidoc: The title, "Setting Up An Environment with DDEV" should have lowercase "an": Setting Up an Environment with DDEV" to be consistent with the other titles in the guide.
    2. source/en/install-ddev.asciidoc : Change "DDEV specific" to "DDEV-specific" in 2 places (line 28 and 169).
    3. source/en/install-prepare.asciidoc: Add comma after "provider". Lines 39-41. Change sentence to:

    Composer and manual download options; if you chose other options, like a
    one-click installer from a hosting provider, consult the relevant documentation
    for any additional steps. 

    That's all I found. Thank you for making this change. +100 for being opinionated about recommending a specific local development environment. I think it's so much more helpful to newcomers than a "Choose Your Own Adventure from many options" approach.

  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Thanks for reviewing this Amber. I've made those edits.

  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    It's great to hear that you agree with this addition @amber, and thanks to both of you for maintaining the User Guide, it's truly a great resource.

  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024