Update DDEV instructions, so users are not required to have PHP and Composer installed on the host system
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- php
- Domain
- documentation
Research direction
Start with the Getting started and Working with DDEV pages linked in the issue, then review the linked pull request for the proposed wording. Done means the instructions run Composer through DDEV without requiring host PHP or Composer, and the Drupal.org project page points users to the current Getting started page.
Written by the indexing model from the issue text.
Description
Existing document
- https://docs.localgovdrupal.org/devs/getting-started/
- https://docs.localgovdrupal.org/devs/getting-started/working-with-ddev.html
In what way is the existing documentation unclear or incomplete
Currently, the method used in the Working with DDEV page requires that PHP and Composer are installed on the host machine, but this can lead to version conflicts, and strange behaviour. See also:
What should the documentation say instead?
It would be better to use a method where Composer is only run from DDEV.
See MR:
Update installation instructions on project page?
Also, the LocalGov Drupal project page could link to https://docs.localgovdrupal.org/devs/getting-started to prevent it from having outdated instructions?
Installing LocalGov Drupal locally
To install LocalGov Drupal locally for testing or development, use the Composer-based project template.
[...]
Maybe better?
Installing LocalGov Drupal locally
To install LocalGov Drupal locally for testing or development, follow the instructions on the Getting started page.
- Dominant language
- No language data
- Stars
- 7
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from localgovdrupal/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
localgovdrupal/docs#348 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
localgovdrupal/docs#340 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
localgovdrupal/docs#332 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
localgovdrupal/docs#333 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 55/100
localgovdrupal/docs#331 ·
All issues in localgovdrupal/docs
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·