docs icon indicating copy to clipboard operation
docs copied to clipboard

Update ddev documentation

Open avhulst opened this issue 1 year ago • 7 comments

Update documentation for Contao 5.3 and newest DDEV version

avhulst avatar Mar 03 '24 10:03 avhulst

Thanks for the update. The “Install DDEV” section could also be simplified. Corresponding instructions are formulated in detail in the ddev documentation. Therefore possibly sufficient:

DDEV is available for various platforms. As a »Windows« user, in addition to the WSL2 workflow (recommended), you can also simply use the current Windows installation binaries.

fkaminski avatar Jul 21 '24 09:07 fkaminski

Add additional information regarding “Create project”. We should mention here that the directory name corresponds to the later “hostname” and that this could also be further configured.

fkaminski avatar Jul 21 '24 10:07 fkaminski

We should perhaps add a new paragraph regarding “Custom PHP Configuration”. For example, for local changes, e.g. “memory_limit = -1” per project etc..

fkaminski avatar Jul 21 '24 10:07 fkaminski

@fkaminski I think the description for PHP settings and hostname is too much documentation as this is a good working example.

avhulst avatar Jul 23 '24 17:07 avhulst

@fkaminski I think the description for PHP settings and hostname is too much documentation as this is a good working example.

With regard to “as much as necessary, as little as possible”, this would certainly be correct. But: I think that a paragraph regarding “Custom PHP Configuration” (with example “memory_limit = -1”) would not be unimportant.

fkaminski avatar Jul 24 '24 07:07 fkaminski

@avhulst After local testing, I think it would not be a bad idea to add this note at the end of the “Additional information” section:

{{% notice note %}} Falls du als Windows Anwender die »Git Bash« als Konsole benutzt, kann es, abhängig von deiner »Git für Windows« Konfiguration, notwendig sein das Kommando winpty voran zu stellen (z. B.: winpty ddev ssh). {{% /notice %}}

{{% notice note %}} If you are a Windows user using the "Git Bash" as a console, it may be necessary, depending on your "Git for Windows" configuration, to prepend the command winpty (e.g.: winpty ddev ssh). {{% /notice %}}

fkaminski avatar Jul 24 '24 15:07 fkaminski

@fkaminski I have added the paragraph 'Custom PHP Configuration' and the 'Git Bash' note for Windows. In my opinion, WSL is sufficiently covered in the DDEV documentation and is too OS specific for me.

avhulst avatar Jul 24 '24 20:07 avhulst