Draft: Some improvements to the README.md #9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rfay
suggested changes
Mar 7, 2024
README.md
Outdated
| ddev start && \ | ||
| ddev get justafish/ddev-drupal-core-dev && \ | ||
| ddev restart && \ | ||
| git clone [email protected]:project/drupal.git core-dev |
There was a problem hiding this comment.
Please use the official git clone technique per
README.md
Outdated
| ddev drupal install | ||
| ```` | ||
| > :warning: There is no need to composer require Drush to get the ability to for example clear caches. A subset of that kind of functionality is available with `ddev drupal list`. Otherwise you won't be able to checkout any added feature branch due to unstaged changes for commit. |
There was a problem hiding this comment.
Suggested change
| > :warning: There is no need to composer require Drush to get the ability to for example clear caches. A subset of that kind of functionality is available with `ddev drupal list`. Otherwise you won't be able to checkout any added feature branch due to unstaged changes for commit. | |
| > :warning: There is no need to `ddev composer require drush/drush` to get the ability to for example clear caches. A subset of that kind of functionality is available with `ddev drupal list`. Otherwise you won't be able to checkout any added feature branch due to unstaged changes for commit. |
Is this warning needed? I would usually just git stash in that situation, but it does seem like having drush available is something people would always want.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
At first thank you for that excellent add-on! As a disclaimer, I am not a developer, but regularly using DDEV, and was used to a composer patches based workflow. So I ran into a few stepping blocks since the add-on has a slight different paradigm I first had to understand. And a few days ago I also noticed a support request on the Drupal Slack with someone having troubles getting the add-on running. So based on my own experience as well as the details I've learned during the conversation on Slack I tried to come up with some improvements for the README.md. Aside adding some more information I also tried to bring in some more structure as well as a TOC.