Write a README for the project template

Created on 22 October 2024, 5 months ago

Problem/Motivation

The Drupal CMS project template is what you use to spin up "real" Drupal CMS sites. It's generated from the project_template directory of our monorepo. That is, therefore, the main entry point into a real Drupal CMS site for most people. We should probably have a friendly README.md in there which explains how to get started with Drupal CMS.

πŸ“Œ Task
Status

Active

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

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

Merge Requests

Comments & Activities

  • Issue created by @phenaproxima
  • Merge request !141Template readme β†’ (Merged) created by phenaproxima
  • Pipeline finished with Canceled
    5 months ago
    Total: 65s
    #317535
  • Pipeline finished with Failed
    5 months ago
    Total: 513s
    #317537
  • Pipeline finished with Success
    5 months ago
    Total: 885s
    #317563
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    I think this needs to happen by RC. Otherwise people will download a release-candidate zip file, unzip it, and not know what to do next.

    Assigning to @eojthebrave as one of the documentation track leads, but I'm guessing I'll be consulted on what the setup procedure is.

  • First commit to issue fork.
  • Pipeline finished with Failed
    4 months ago
    Total: 63s
    #349560
  • Pipeline finished with Failed
    4 months ago
    Total: 64s
    #349559
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    I added some changes with my initial thoughts on what a more complete README should contain.

    My biggest question is regarding the content about using `composer launch` and whether we want to include that at all? Personally, I think we should recommend DDEV in the README and then maybe provide a link to other options. I think limiting the number of choices, and therefore decisions, someone has to make to get started will help make it easier for most people.

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

    I'm completely okay with removing composer launch. It assumes you have a PHP interpreter available, but it uses PHP's built-in web server along with SQLite, so it's actually a pretty quick way to get going.

    But, if the product owner is on board with removing it, I'm not married to keeping it.

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Assigning to Pam for reviewing this proposed README, and making a decision on whether to keep composer launch or jettison it.

  • πŸ‡¦πŸ‡ΊAustralia pameeela

    This is great, thanks @eojthebrave!

    Happy to remove composer launch in the name of simplicity. Also added some suggestions/edits.

  • Pipeline finished with Failed
    4 months ago
    Total: 63s
    #350654
  • Pipeline finished with Failed
    4 months ago
    Total: 65s
    #350655
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    I guess this is back to @eojthebrave?

    Also, as per Pam's feedback, go ahead and rip out composer launch. Rest in peace!

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts
  • Pipeline finished with Failed
    4 months ago
    Total: 64s
    #350830
  • Pipeline finished with Failed
    4 months ago
    Total: 66s
    #350829
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    I like it. Over to you, Pam!

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Build is failing because this is extremely out of date with HEAD (still using Drupal 10)! That needs to be fixed. Reassigning to @eojthebrave.

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

    And back to Pam, for the first time, for the last time.

  • Pipeline finished with Success
    4 months ago
    Total: 2146s
    #351041
  • Pipeline finished with Success
    4 months ago
    Total: 2291s
    #351040
  • πŸ‡¦πŸ‡ΊAustralia pameeela

    I made some more minor changes, I think it needs a revisit post-RC and pre-release, for one thing the part about creating a site only with the browser will only be true once we have a trial experience, otherwise you need DDEV as explained below.

    But don't want to hold it up any longer. I will create a follow up.

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Thanks for working on this, y'all. I like what you came up with. It'll need a revisit, that's true, but at least now people who extract the zip file will have some kind of instructions to go on. Merged into 0.x.

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

Production build 0.71.5 2024