The repository is missing a README file

Created on 20 August 2024, 4 months ago
Updated 10 September 2024, 3 months ago

Problem/Motivation

Currently, the repository at project/drupal_cms is missing a README file. This makes it hard to set up the project. This is especially true when not having worked with recipes before, as the project structure is different.

Proposed resolution

We could take over some parts of the README file from phenaproxima/starshot-prototype, although it does not apply fully to this repository. I like the idea of having a quick-start script in DDEV.

Remaining tasks

1. Define the starting point for a README
2. Write a README applicable to Drupal CMS

πŸ“Œ Task
Status

Fixed

Component

Documentation

Created by

πŸ‡©πŸ‡ͺGermany simonbaese Berlin

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

Merge Requests

Comments & Activities

  • Issue created by @simonbaese
  • First commit to issue fork.
  • Merge request !38Add README file β†’ (Merged) created by ressa
  • Status changed to Needs review 4 months ago
  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    I agree, a README file would be great, to help users try out Drupal CMS more easily. Here's a rough sketch, based on the Starshot README.

    The composer quick-start command doesn't quite complete, and does not install Drupal. So until that's fixed, the user needs to manually install, so I have added those steps, as well as how to create a log in link.

    I don't think the "Not using DDEV?"-installation method works any more, so I removed it.

  • Pipeline finished with Failed
    4 months ago
    Total: 5676s
    #264054
  • First commit to issue fork.
  • Pipeline finished with Canceled
    4 months ago
    Total: 81s
    #266059
  • πŸ‡©πŸ‡ͺGermany spuky

    This issue helped me get up an running with starshot

    Did some changes that i Had to figure out... while folowing the installation instructions..

    +1 for rtbc

  • Pipeline finished with Success
    4 months ago
    Total: 534s
    #266062
  • Status changed to Needs work 4 months ago
  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    Great that it helped, and thanks for the update! I notice "Brwoser" in the new text (should be "browser"), maybe it can be fixed?

    Hopefully someone else can review and change to RTBC, if they think it is.

  • Status changed to Needs review 4 months ago
  • πŸ‡©πŸ‡ͺGermany spuky
  • Status changed to Postponed 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Thanks for working on this, but this should not happen right now.

    Drupal CMS is under heavy development and has already deviated significantly from the prototype, so what's in the README is, largely, no longer applicable.

    I think this should wait until we roll a tagged release (alpha or beta).

  • Pipeline finished with Success
    4 months ago
    Total: 551s
    #266116
  • πŸ‡©πŸ‡ͺGermany spuky

    understand that.. got here by:

    issues on my project filed by another Maintainer trying out starshot

    found:
    https://www.drupal.org/project/starshot β†’

    which invites to tryout the Proto type

    which says it is now here...

    Was a little lost on how to get the repo up and running.

    So maybe a readme...

    WARNING:
    THIS REPO IS for DEV DO NOT BUILD PRODUCTION SITES BASED ON IT

    and striped down Install instructions would help

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

    Thanks for clarifying @phenaproxima.

    I do think we should post somewhere (README? documentation page?) how to get Drupal CMS up and running, for developers and curious users, such as me and @spuky, even during this development phase. There are surely many others who also would like to give Drupal CMS a test spin.

    Aside from experiencing Drupal CMS, they can also help catch regressions, such as #3470145: To respect user privacy and comply with GDPR, use openstreetmap.de for Leaflet maps β†’ .

  • πŸ‡©πŸ‡ͺGermany spuky

    / start irony
    Sorry for not seeking for

    help on the wiki page

    that is linked nowhere... but on the gitlab page...
    where you first have to Seek out the wiki under Plan... then get an 404 because there is no route page ...
    but discover the 3 pages on the righthand Side

    i guess that is fine and everybody will find his way...
    /end irony

    Can we do better ?

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

    No, you're right, it should be linked from somewhere for sure.

  • πŸ‡©πŸ‡ͺGermany spuky

    Updated the MR to a minimal Readme... pointing the way..

  • Pipeline finished with Success
    4 months ago
    Total: 448s
    #266213
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    That seems like a reasonable compromise!

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts
  • Status changed to Needs review 4 months ago
  • πŸ‡©πŸ‡ͺGermany simonbaese Berlin

    Just wanted to comment. Thanks for the compromise. Maybe I should have been more precise in the issue. I also intended to add a readme to guide contributors to Drupal CMS - not a readme for a release. I went on a similar journey as described in an earlier comment. I read about an issue, but instead of getting started smoothly, I had to spend more time than necessary to set up the project. It is funny that I only learned about the wiki through this issue.

  • Pipeline finished with Success
    4 months ago
    Total: 430s
    #266226
  • πŸ‡©πŸ‡ͺGermany simonbaese Berlin

    Also, the initial commit to this MR is quite informative: Initial commit. Maybe we can keep it in the back of our minds.

  • Status changed to RTBC 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts
  • Pipeline finished with Skipped
    4 months ago
    #266240
  • Status changed to Fixed 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Merged. I think this will be helpful for folks, so nobody has to go on the side quest described in the last few comments.

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

    Thanks all! This is great, and will help many users install Drupal CMS much more easily.

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

Production build 0.71.5 2024