Backdrop4Good / backdrop4good.org

Backdrop for Good site.
3 stars 1 forks source link

Improve README.md #17

Open olafgrabienski opened 6 years ago

olafgrabienski commented 6 years ago

When I spinned up the Backdrop4Good site locally as described in https://github.com/Backdrop4Good/backdrop4good.org/blob/master/README.md, I noticed some issues which can be fixed improving the instructions. Here are a few suggestions and some comments:

git clone

Current:

Suggestion:

settings.php

Current:

Comment:

There was already a settings.php in the directory, and the downloaded file was renamed to settings.php.1. Should we simply start the text with something like "Remove the settings.php from the web directory", and then: add the file from Github and so on as described above?

lando start

Current:

Comment:

I was not sure if I have to type that command from the web directory. I even forgot if I did it and if it was succesful, I guess yes. I suggest however to add instructions like cd xyz anywhere in the README, even in cases where it might be implicetly clear for experienced developers if they are already in the correct directory or not.

Other

When I went to the site in the browser, I got an exception saying that the '../config/active' directory is empty or missing crucial files. I checked it and saw the directory wasn't there. Suggestions in Gitter to fix were: (a) type lando drush bcim in web, or (b) create the missing directory and copy all files from the existing directory config/staging to the created config/active. While (b) worked, (a) didn't.

Not sure if this is a bug or a documentation issue.