Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ddev documentation #1356

Open
wants to merge 21 commits into
base: main
Choose a base branch
from

Conversation

avhulst
Copy link
Contributor

@avhulst avhulst commented Mar 3, 2024

Update documentation for Contao 5.3 and newest DDEV version

@fkaminski
Copy link
Contributor

fkaminski commented Jul 21, 2024

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
Copy link
Contributor

fkaminski commented Jul 21, 2024

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
Copy link
Contributor

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

@avhulst
Copy link
Contributor Author

avhulst commented Jul 23, 2024

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

@fkaminski
Copy link
Contributor

fkaminski commented Jul 24, 2024

@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
Copy link
Contributor

@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 %}}

avhulst and others added 5 commits July 24, 2024 21:42
Co-authored-by: Franko <fkaminski@bremen-office.de>
Co-authored-by: Franko <fkaminski@bremen-office.de>
Co-authored-by: Franko <fkaminski@bremen-office.de>
@avhulst
Copy link
Contributor Author

avhulst commented Jul 24, 2024

@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.

Copy link
Contributor

@fkaminski fkaminski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My final comments. @fritzmg / @netzarbeiter Otherwise I think it's great.

docs/manual/guides/local-installation/ddev.de.md Outdated Show resolved Hide resolved
docs/manual/guides/local-installation/ddev.en.md Outdated Show resolved Hide resolved
docs/manual/guides/local-installation/ddev.en.md Outdated Show resolved Hide resolved
docs/manual/guides/local-installation/ddev.de.md Outdated Show resolved Hide resolved
avhulst and others added 4 commits July 25, 2024 09:09
Co-authored-by: Franko <fkaminski@bremen-office.de>
Co-authored-by: Franko <fkaminski@bremen-office.de>
Co-authored-by: Franko <fkaminski@bremen-office.de>
Co-authored-by: Franko <fkaminski@bremen-office.de>
Copy link
Contributor

@fkaminski fkaminski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some typo/formatting (with help of deepl) ...

docs/manual/guides/local-installation/ddev.de.md Outdated Show resolved Hide resolved
docs/manual/guides/local-installation/ddev.de.md Outdated Show resolved Hide resolved
docs/manual/guides/local-installation/ddev.de.md Outdated Show resolved Hide resolved
docs/manual/guides/local-installation/ddev.en.md Outdated Show resolved Hide resolved
docs/manual/guides/local-installation/ddev.en.md Outdated Show resolved Hide resolved
avhulst and others added 5 commits July 25, 2024 17:41
Co-authored-by: Franko <fkaminski@bremen-office.de>
Co-authored-by: Franko <fkaminski@bremen-office.de>
Co-authored-by: Franko <fkaminski@bremen-office.de>
Co-authored-by: Franko <fkaminski@bremen-office.de>
Co-authored-by: Franko <fkaminski@bremen-office.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants