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

docs: Update PHPStorm instructions to include COMPOSE_PROJECT_NAME in manual instructions #6226

Merged
merged 2 commits into from
Jun 2, 2024

Conversation

michielgerritsen
Copy link
Contributor

The Issue

The PHPStorm instructions are pretty clear, but setting the COMPOSE_PROJECT_NAME was missing from the instructions, making it impossible to set up PHPStorm. The screenshot already included this variable.

How This PR Solves The Issue

It adds a step in the instructions that explains that you need to set it and what the value should be.

Manual Testing Instructions

  • Set up a new project.
  • Open it in PHPStorm.
  • Follow the instructions.

Automated Testing Overview

You can't automate this afaik.

Related Issue Link(s)

N/A

Release/Deployment Notes

N/A

@michielgerritsen michielgerritsen requested a review from a team as a code owner May 21, 2024 14:18
@rfay rfay changed the title docs: Update PHPStorm instructions docs: Update PHPStorm instructions to include COMPOSE_PROJECT_NAME in manual instructions May 21, 2024
@rfay
Copy link
Member

rfay commented May 21, 2024

Thanks, I'm surprised that was missing. The numbering looks wrong in the PR, but seems to come out OK when rendered, https://ddev--6226.org.readthedocs.build/en/6226/users/install/phpstorm/#manual-setup

Copy link
Member

@rfay rfay left a comment

Choose a reason for hiding this comment

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

Thanks!

It's odd that COMPOSE_PROJECT_NAME is still required, since the project name is set in the .ddev/.ddev-docker-compose-full.yaml.

I wonder if it was removed here when it was introduced into the .ddev-docker-compose-full.yaml

@rfay
Copy link
Member

rfay commented May 22, 2024

One question @michielgerritsen - AFAIK nobody has been able to get the PHP client setup working in PhpStorm 2024.x. Does that mean you were manually setting up PhpStorm 2023.x?

@michielgerritsen
Copy link
Contributor Author

Hey @rfay, are you talking about the PHPStorm plugin? My version was too new to install it. I have version 2024.something (1?), and that was not supported. But I needed to run my tests so that's why I followed those steps.

@rfay
Copy link
Member

rfay commented May 23, 2024

This was impossible to get working until PhpStorm 2024.2 EAP. But I do confirm that it can work in PhpStorm 2024.2 EAP. See https://discordapp.com/channels/664580571770388500/1239527694371131403/1242893198616039615

Copy link
Contributor

@SchmidtWebmedia SchmidtWebmedia left a comment

Choose a reason for hiding this comment

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

I've learned with a project name like PHPInterpreter and it doesn't work

docs/content/users/install/phpstorm.md Outdated Show resolved Hide resolved
Co-authored-by: Marco Schmidt <[email protected]>
@rfay rfay merged commit a14e827 into ddev:master Jun 2, 2024
10 checks passed
jonesrussell pushed a commit to jonesrussell/ddev that referenced this pull request Jun 9, 2024
… manual instructions (ddev#6226) [skip ci]

Co-authored-by: Randy Fay <[email protected]>
Co-authored-by: Marco Schmidt <[email protected]>
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.

None yet

3 participants