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: Minor updates to DDEV tutorial #382

Merged
merged 3 commits into from
May 22, 2024

Conversation

rfay
Copy link
Contributor

@rfay rfay commented May 20, 2024

  • DDEV provides the ddev typo3 command, so no ./vendor/bin is required.
  • Note that vendor/bin is in the $PATH anyway, so need not be listed.
  • PhpMyAdmin is no longer provided by default, so ddev launch -p no longer exists

* DDEV provides the `ddev typo3` command, so no ./vendor/bin is required.
* Note that ` vendor/bin` is in the $PATH anyway, so need not be listed. 
* PhpMyAdmin is no longer provided by default, so `ddev launch -p` no longer exists
@rfay
Copy link
Contributor Author

rfay commented May 21, 2024

I took another pass through and smoothed out a couple of other things. I think it has everything now. I haven't done rst in recent memory, so may have messed something up there.

@garvinhicking garvinhicking self-assigned this May 21, 2024
Copy link
Contributor

@garvinhicking garvinhicking left a comment

Choose a reason for hiding this comment

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

Hi Randy,

I feel honoured to be able to review your contribution, thank you so much for everything you do with DDEV and the community.

I think this is a very helpful improvement, I just made one debatable change on whether to include setting the PHP version here. What do you think about my comments there?

Co-authored-by: Garvin Hicking <[email protected]>
@rfay
Copy link
Contributor Author

rfay commented May 21, 2024

Thanks. My experience with projects like TYPO3 is they keep close to the current stable PHP version, which DDEV also does, so I've been sometimes removing explicit PHP versions because they just get out-of-date so fast. But your preference is what matters!

@DavidBruchmann
Copy link

DavidBruchmann commented May 21, 2024

I agree with Garvin, mentioning the PHP version makes updates also easier as the combination of TYPO3 version and PHP version is always important, and having to search the right PHP version for an older project can be a pain (especially for very old versions though, where DDEV is not even an option) especially if it's in a team or beyond where projects are shared, and not every project is updated in cycles like it should be.
Another argument is that some installed packages have different restrictions concerning the PHP version, then it's good to have the correct version already known.
Anyway, thanks for the PR!

@garvinhicking
Copy link
Contributor

Thanks for your feedback!

(especially for very old versions though, where DDEV is not even an option)

Just a sidenote - thanks to Randys write-up I actually run a TYPO3 4.5 install with PHP 5.2 😅

I'm waiting for feedback from team lead @linawolf to see if she agrees, then we'll get this merged! :)

@DavidBruchmann
Copy link

DavidBruchmann commented May 21, 2024

Indeed, concerning TYPO3 versions DDEV has much less limits than composer, especially considering that TYPO3 wasn't handled optimal in the beginning with composer.

@rfay
Copy link
Contributor Author

rfay commented May 21, 2024

TYPO3 4.5 install with PHP 5.2

WOW???

@linawolf
Copy link
Member

@rfay Thanks alot for suggesting these changes! I would agree with @garvinhicking to keep the php version. It is an important information and you want to set it to the version you are using on your server preferably.

Also we did have issues in the past, where a new TYPO3 Version was published requiring a certain PHP version but DDEV did not ship that version by default yet. (I think this happened with TYPO3 12.0 or 12.4?) So it is good to know how to set that.

@garvinhicking garvinhicking merged commit 77d12ac into TYPO3-Documentation:main May 22, 2024
4 checks passed
Copy link
Contributor

The backport to 12.4 failed:

The process '/usr/bin/git' failed with exit code 1
stderr
error: could not apply 974efb2... Clean up a few more things
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
hint: Disable this message with "git config advice.mergeConflict false"

stdout
Auto-merging Documentation/Installation/TutorialDdev.rst
[backport-382-to-12.4 18ea899] docs: Minor updates to DDEV tutorial
 Author: Randy Fay <[email protected]>
 Date: Mon May 20 14:22:34 2024 -0600
 1 file changed, 2 insertions(+), 9 deletions(-)
Auto-merging Documentation/Installation/TutorialDdev.rst
CONFLICT (content): Merge conflict in Documentation/Installation/TutorialDdev.rst

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-12.4 12.4
# Navigate to the new working tree
cd .worktrees/backport-12.4
# Create a new branch
git switch --create backport-382-to-12.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick b568413ce8a6e81acdb4d1e4b8a053cc6150836d,974efb21a76839ac012901030a3e466b539108f9,7c65117d72c2c330f9bef99e388fd30011abdf77
# Push it to GitHub
git push --set-upstream origin backport-382-to-12.4
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-12.4

Then, create a pull request where the base branch is 12.4 and the compare/head branch is backport-382-to-12.4.

@garvinhicking
Copy link
Contributor

Merged and backported to 12.4 docs. Thanks again, Randy! 👍

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.

4 participants