From b293d8824d72797f441e9846010902684db80277 Mon Sep 17 00:00:00 2001 From: Matthias Andrasch <777278+mandrasch@users.noreply.github.com> Date: Sun, 19 May 2024 19:41:09 +0200 Subject: [PATCH] chore: content updates --- docs/tutorials/cloud/codespaces.md | 17 ++++++++++ docs/tutorials/cms-and-frameworks/craftcms.md | 8 +---- docs/tutorials/cms-and-frameworks/kirby.md | 6 +++- docs/tutorials/cms-and-frameworks/laravel.md | 31 +++++-------------- docs/tutorials/cms-and-frameworks/statamic.md | 5 +-- docs/tutorials/cms-and-frameworks/typo3.md | 20 +++++------- .../tutorials/cms-and-frameworks/wordpress.md | 2 +- docs/tutorials/docker-runtimes/orbstack.md | 5 ++- docs/tutorials/nodejs-tools/vite.md | 6 ++-- 9 files changed, 48 insertions(+), 52 deletions(-) diff --git a/docs/tutorials/cloud/codespaces.md b/docs/tutorials/cloud/codespaces.md index faa48ae..455f837 100644 --- a/docs/tutorials/cloud/codespaces.md +++ b/docs/tutorials/cloud/codespaces.md @@ -8,10 +8,27 @@ The source code for the feature `install-ddev` can be found here here: - https://github.com/ddev/ddev/tree/master/.github/devcontainers/src/install-ddev +You most likely will need a `wait_for_docker` function in your `postCreateCommand`-script: + +```bash +# retry, see https://github.com/ddev/ddev/pull/5592 +wait_for_docker() { + while true; do + docker ps > /dev/null 2>&1 && break + sleep 1 + done + echo "Docker is ready." +} +``` + +See e.g.: https://github.com/mandrasch/ddev-craftcms-vite/blob/main/.devcontainer/postCreateCommand.sh + ## Troubleshooting ### Could not connect to docker (daemon) +Update 19.05.2024: The issue seems to still happen randomly, updated issue: https://github.com/devcontainers/features/issues/977 + There was a randomly occuring error "Could not connect to docker daemon", which was fixed in recent versions of `docker-in-docker`: - https://github.com/devcontainers/images/pull/705 diff --git a/docs/tutorials/cms-and-frameworks/craftcms.md b/docs/tutorials/cms-and-frameworks/craftcms.md index 87a21c2..f624f1b 100644 --- a/docs/tutorials/cms-and-frameworks/craftcms.md +++ b/docs/tutorials/cms-and-frameworks/craftcms.md @@ -33,12 +33,6 @@ ploi.io is a server management tool, I explored this topic here: https://dev.to/mandrasch/install-craftcms-via-ploiio-on-hetzner-cloud-including-ddev-57f8 -## Deployment via Deployer - -I started to explore to explore this topic. Currently I'm not using deployer anymore for these tasks. - -- [Deploy Craft CMS with DDEV, Deployer and Ploi on Hetzner Cloud - Part 1](https://dev.to/mandrasch/deploy-craft-cms-with-ddev-deployer-and-ploi-on-hetzner-cloud-part-1-27l2) - ## Connect with the community 🤗 -There is a dedicated #craftcms-Channel on [DDEV discord](https://discord.gg/hCZFfAMc5k)! +Questions or problems regarding DDEV usage? Feel free to join the [DDEV discord](https://discord.gg/hCZFfAMc5k) and connect with the helpful community! diff --git a/docs/tutorials/cms-and-frameworks/kirby.md b/docs/tutorials/cms-and-frameworks/kirby.md index 5e7f074..a830cec 100644 --- a/docs/tutorials/cms-and-frameworks/kirby.md +++ b/docs/tutorials/cms-and-frameworks/kirby.md @@ -5,7 +5,7 @@ head: content: "" --- -#::: info +::: info 🚧   This chapter is work in progress (WIP) . Happy to hear [your feedback / ideas](https://github.com/mandrasch/my-ddev-lab/issues)! ::: @@ -13,3 +13,7 @@ head: - https://github.com/mandrasch/ddev-kirby-starterkit - https://github.com/mandrasch/ddev-kirby-plainkit + +## Connect with the community 🤗 + +Questions or problems regarding DDEV usage? Feel free to join the [DDEV discord](https://discord.gg/hCZFfAMc5k) and connect with the helpful community! diff --git a/docs/tutorials/cms-and-frameworks/laravel.md b/docs/tutorials/cms-and-frameworks/laravel.md index 5f5beee..f4c1e73 100644 --- a/docs/tutorials/cms-and-frameworks/laravel.md +++ b/docs/tutorials/cms-and-frameworks/laravel.md @@ -1,33 +1,20 @@ # Laravel -::: info -🚧   This chapter is work in progress (WIP) . Happy to hear [your feedback / ideas](https://github.com/mandrasch/my-ddev-lab/issues)! -::: +See -This is the quickstart for the latest Laravel version with NodeJS LTS: +- my latest guide on Laravel + DDEV + Vite: https://dev.to/mandrasch/install-laravel-with-vite-support-in-ddev-docker-4lmh +- my demo repository https://github.com/mandrasch/ddev-laravel-vite. -```bash -ddev config --project-type=laravel --docroot=public --create-docroot --php-version=8.1 --nodejs-version=18 -ddev composer create --prefer-dist --no-install --no-scripts laravel/laravel -y -ddev composer install -ddev artisan key:generate -ddev launch -``` +as well as the official [DDEV quick start docs](https://ddev.readthedocs.io/en/stable/users/quickstart/#laravel). -Source: Official [DDEV quick start docs](https://ddev.readthedocs.io/en/stable/users/quickstart/#laravel), slightly modified +Other demos, they might need an update: -## Vite support - -See the README of [ddev-laravel-vite](https://github.com/mandrasch/ddev-laravel-vite#how-was-this-created). - -- https://github.com/mandrasch/ddev-laravel-vite (WIP / NEW) -- https://github.com/mandrasch/ddev-laravel-breeze-vite/ (Outdated, needs changes) - -Also check out [DDEV + vite](/tutorials/nodejs-tools/vite) for more technical information. +- https://github.com/mandrasch/ddev-laravel-breeze-vite/ +- https://github.com/mandrasch/ddev-laravel-breeze-livewire ## Connect with the community 🤗 -Check out [DDEV Discord](https://discord.gg/hCZFfAMc5k)! +Questions or problems regarding DDEV usage? Feel free to join the [DDEV discord](https://discord.gg/hCZFfAMc5k) and connect with the helpful community!
@@ -38,5 +25,3 @@ Outdated documentation: - https://github.com/mandrasch/ddev-breeze-inertia-vue-starter (outdated) - -Would be also cool to test Statamic, LiveWire, etc. 🤗 diff --git a/docs/tutorials/cms-and-frameworks/statamic.md b/docs/tutorials/cms-and-frameworks/statamic.md index 72d3c83..7021518 100644 --- a/docs/tutorials/cms-and-frameworks/statamic.md +++ b/docs/tutorials/cms-and-frameworks/statamic.md @@ -6,7 +6,7 @@ head: --- ::: info -This chapter is work in progress (WIP) 🚧, [browsersync / asset compilation](https://github.com/tyler36/ddev-browsersync#laravel-mix-example) needs to be implemented for example. Also support for [vite](https://stackoverflow.com/questions/72130137/ddev-laravel-vite-websockets-with-soketi-trouble-with-port-configuration/72405747) would be awesome. Happy to hear [your feedback / ideas](https://github.com/mandrasch/my-ddev-lab/issues)! +This chapter is work in progress (WIP) 🚧, [browsersync / asset compilation](https://github.com/tyler36/ddev-browsersync#laravel-mix-example) needs to be implemented for example. Also support for [Vite](https://stackoverflow.com/questions/72130137/ddev-laravel-vite-websockets-with-soketi-trouble-with-port-configuration/72405747) would be awesome. Happy to hear [your feedback / ideas](https://github.com/mandrasch/my-ddev-lab/issues)! ::: # Statamic @@ -84,6 +84,7 @@ ddev launch /cp General source: https://peak.1902.studio/getting-started/installation.html#installation-via-the-cli **TODO:** + ### Troubleshooting If the starter kit install fails with `Composer could not authenticate with GitHub!`, [generate a token with no permissions](https://github.com/settings/tokens/new) on GitHub and store it to DDEV: @@ -118,7 +119,7 @@ TODO: Add example for pull of these directories to local DDEV / use extension/.z ## TODOs - [ ] Add support for [browsersync / asset compilation](https://github.com/tyler36/ddev-browsersync#laravel-mix-example) via LaravelMix. -(https://discord.com/channels/664580571770388500/912420662847619162/992748945107341372) + (https://discord.com/channels/664580571770388500/912420662847619162/992748945107341372) - [ ] Add support for Vite as soon as it is implemented officially https://stackoverflow.com/questions/72130137/ddev-laravel-vite-websockets-with-soketi-trouble-with-port-configuration/72405747 - [ ] Implement DDEV pull script as addon(?) diff --git a/docs/tutorials/cms-and-frameworks/typo3.md b/docs/tutorials/cms-and-frameworks/typo3.md index f3c480f..07b2a2b 100644 --- a/docs/tutorials/cms-and-frameworks/typo3.md +++ b/docs/tutorials/cms-and-frameworks/typo3.md @@ -8,7 +8,7 @@ head: # Typo3 ::: info -🚧   This chapter is work in progress (WIP) . Happy to hear [your feedback / ideas](https://github.com/mandrasch/my-ddev-lab/issues)! +🚧   This chapter is most likely outdate. ::: **Quickstart** @@ -16,13 +16,12 @@ head: For a quickstart see the official typo3 docs: https://ddev.readthedocs.io/en/latest/users/quickstart/#typo3 -TYPO3 Quick Installation Guide using DDEV, Composer and Sitepackagebuilder: +See the official TYPO3 guide as well: +https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/Installation/TutorialDdev.html -https://florian.geierstanger.org/blog/typo3-installation-guide - -Also a a very good tutorial on how to setup a local DDEV environment for typo3 and deploy everything via Gitlab/Github/Bitbucket pipelines: +**Vite?** -https://t3terminal.com/blog/de/typo3-gitlab-deployment/ +- See https://github.com/s2b/vite-asset-collector **DDEV providers (pull) integration** @@ -39,11 +38,6 @@ WANTED: Example code. If you have a ddev/providers/-script which pulls database - See twitter discussion https://twitter.com/m_andrasch/status/1552193558857359360 -**Vite?** - -- See twitter discussion: https://twitter.com/kino_auge/status/1539843362127319040 -- NEW: https://github.com/fgeierst/typo3-vite-demo - -## Connect with community 🤗 +## Connect with the community 🤗 -There is a dedicated #typo3-Channel on [DDEV discord](https://discord.gg/hCZFfAMc5k)! +Questions or problems regarding DDEV usage? Feel free to join the [DDEV discord](https://discord.gg/hCZFfAMc5k) and connect with the helpful community! diff --git a/docs/tutorials/cms-and-frameworks/wordpress.md b/docs/tutorials/cms-and-frameworks/wordpress.md index 45b338f..55dd0c8 100644 --- a/docs/tutorials/cms-and-frameworks/wordpress.md +++ b/docs/tutorials/cms-and-frameworks/wordpress.md @@ -8,7 +8,7 @@ head: # WordPress ::: info -🚧   This chapter is work in progress (WIP) . Happy to hear [your feedback / ideas](https://github.com/mandrasch/my-ddev-lab/issues)! +🚧   This chapter might be slightly outdated. Happy to hear [your feedback / ideas](https://github.com/mandrasch/my-ddev-lab/issues)! ::: ## Quick install diff --git a/docs/tutorials/docker-runtimes/orbstack.md b/docs/tutorials/docker-runtimes/orbstack.md index 4d5ae85..29d921d 100644 --- a/docs/tutorials/docker-runtimes/orbstack.md +++ b/docs/tutorials/docker-runtimes/orbstack.md @@ -1,6 +1,5 @@ # Orbstack -Haven't tested it, but looks promising: +Orbstack runs very smooth and fast on Macs: https://orbstack.dev/ -- https://orbstack.dev/ -- https://github.com/ddev/ddev/issues/4858 +It is currently my runtime of choice. diff --git a/docs/tutorials/nodejs-tools/vite.md b/docs/tutorials/nodejs-tools/vite.md index 2eadf70..956252c 100644 --- a/docs/tutorials/nodejs-tools/vite.md +++ b/docs/tutorials/nodejs-tools/vite.md @@ -7,6 +7,8 @@ head: # Vite +NEW: I wrote a detailed guide here: https://ddev.com/blog/working-with-vite-in-ddev/ + ## Expose all the ports!!1 The most important thing for vite is to expose the vite port (5173) so that it can be accessed from outside the DDEV docker container (= from your laptop). @@ -34,13 +36,13 @@ See some examples here: ### Laravel -- https://github.com/mandrasch/ddev-laravel-vite (WIP) +- https://github.com/mandrasch/ddev-laravel-vite - https://github.com/mandrasch/ddev-laravel-breeze-vite/ (Outdated, needs changes) - https://github.com/tyler36/lara10-base-demo/ ### CraftCMS -- https://github.com/mandrasch/ddev-craftcms-vite (WIP) +- https://github.com/mandrasch/ddev-craftcms-vite - See: https://nystudio107.com/docs/vite/#using-ddev - https://twitter.com/thomasbendl/status/1628741476355112962 / https://github.com/szenario-fordesigners/craft-vite-starter