Laravel + Docker guide #21276

rw4lll · 2024-10-29T22:42:15Z

Description

Introduces new section /frameworks and adds first guide for Laravel PHP framework based on Docker Compose with examples for development and production environments.

Additionally (a topic to discuss) introduces boolean flag "external" for sidebar links to improve the user experience, when dealing with external links to open them in a new tab.

Related issues or tickets

Closes Laravel + Docker guide #21268

Reviews

Technical review
Editorial review
Product review

netlify · 2024-10-29T22:42:31Z

✅ Deploy Preview for docsdocker ready!

Name	Link
🔨 Latest commit	`acf46fb`
🔍 Latest deploy log	https://app.netlify.com/sites/docsdocker/deploys/678518372ec7680008b3efde
😎 Deploy Preview	https://deploy-preview-21276--docsdocker.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

dvdksn

Thanks a lot @rw4lll

Is this PR ready for review yet? 🔍

content/guides/frameworks/laravel/development-setup.md

content/guides/frameworks/laravel/production-setup.md

content/guides/frameworks/laravel/development-setup.md

content/guides/frameworks/laravel/production-setup.md

rw4lll · 2024-10-30T19:06:47Z

Thanks a lot @rw4lll

Is this PR ready for review yet? 🔍

I hope so 😄 . I've tried to add tags, but it seems that if add a new tag, its not recognized:

tags: [frameworks]
languages: [php]

This will return error like:

2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/_index.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/_index.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/common-questions.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/prerequisites.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/production-setup.md
2024-10-30 20:00:23 ERROR [tags] Undefined tag: 'frameworks' in /project/content/guides/frameworks/laravel/development-setup.md
2024-10-30 20:00:25 Built in 4527 ms
2024-10-30 20:00:25 Error: error building site: logged 6 error(s)

But if I use any other tag which already exists, it works well. Where can I register new "frameworks" tag or should I use one existing?

rw4lll · 2024-10-31T18:23:40Z

@dvdksn added tag support

dvdksn · 2024-11-04T12:31:56Z

layouts/partials/sidebar/guides.html

    <ul class="ml-4 space-y-2">
      {{- range . }}
-        <li><a href="{{ .url }}" class="link">{{ .title }}</a></li>
+        <li><a href="{{ .url }}" {{- if .external }} target="_blank" {{- end }} class="link">{{ .title }}</a></li>


Let's remove this and the corresponding front matter property; last week I'd said LGTM but I was recently made aware that target=_blank is a bad pattern. See this issue:

Please remove target="_blank" on links #21291

Sure, fixed

content/guides/frameworks/laravel/_index.md

content/guides/frameworks/laravel/prerequisites.md

dvdksn · 2024-11-04T13:27:59Z

content/guides/frameworks/laravel/development-setup.md

+# Install NVM (Node Version Manager) as the www user
+RUN export NVM_DIR="$HOME/.nvm" && \
+    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash && \
+    [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh" && \
+    nvm install ${NODE_VERSION} && \
+    nvm alias default ${NODE_VERSION} && \
+    nvm use default
+
+# Ensure NVM is available for all future shells
+RUN echo 'export NVM_DIR="$HOME/.nvm"' >> /home/www/.bashrc && \
+    echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"' >> /home/www/.bashrc && \
+    echo '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"' >> /home/www/.bashrc


Can you explain why you're using NVM here?

@dvdksn sure, the idea is to use this container as a workspace for laravel local development. It should include at least php cli for running artisan commands and node for assets building. Nvm here helps to switch between node versions easily through the env param.

dvdksn · 2024-11-04T13:30:37Z

content/guides/frameworks/laravel/development-setup.md

+        UID: ${UID}
+        GID: ${GID}


If GID and UID env vars are unset, this would set UID and GID to empty strings, and thereby override the default 1000 set in the Dockerfile

dvdksn · 2024-11-04T13:33:18Z

content/guides/frameworks/laravel/development-setup.md

+      - "${POSTGRES_PORT}:5432"
+    environment:
+      - POSTGRES_DB=${POSTGRES_DATABASE}
+      - POSTGRES_USER=${POSTGRES_USERNAME}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}


This compose file has a lot of dependencies to environment variables. I think it's better to try and keep non-secret values in the compose file directly. Still, the .env will need some explanation.

content/guides/frameworks/laravel/development-setup.md

rw4lll · 2024-12-27T16:52:10Z

@dvdksn After the review I've decided to refactor the example repo to make it simpler and optimize it by utilizing multi-stage builds where possible. Imo it should looks better now. So I've updated the guide following the review feedback, as well as the updates from example repo.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

dvdksn

💪🏻💯 I just pushed some formatting/wording updates, and added some terms to our style/vocabulary files. LGTM!

Two things that I'd like to do:

Fork the example repository into the dockersamples org and link there. Would you be OK with that @rw4lll?
Add a note that attributes the guide to you, to thank you for the hard work you put in to create this 🙏🏻 Similar to what we have e.g. here - is that OK with you @rw4lll and if so, where would you want the link to point to?

rw4lll · 2025-01-10T19:32:59Z

@dvdksn Thanks, that sounds great! 🎉

Yes, absolutely.
Of course! You can point the link to my GitHub profile. Let me know if there’s anything else you’d need from me!

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

dvdksn

Thanks @rw4lll

github-actions bot added hugo Updates related to hugo area/guides labels Oct 29, 2024

dvdksn reviewed Oct 30, 2024

View reviewed changes

rw4lll requested a review from dvdksn October 31, 2024 18:23

dvdksn reviewed Nov 4, 2024

View reviewed changes

rw4lll requested a review from dvdksn December 27, 2024 16:52

vale: add exceptions for PHP-related terms

4a6c5ae

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

dvdksn force-pushed the laravel-compose branch from 77b1aad to 56021cc Compare January 9, 2025 12:40

github-actions bot added the area/tests label Jan 9, 2025

dvdksn previously approved these changes Jan 9, 2025

View reviewed changes

guides: Add Docker+Laravel example

acf46fb

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

dvdksn dismissed their stale review via acf46fb January 13, 2025 13:42

dvdksn force-pushed the laravel-compose branch from 56021cc to acf46fb Compare January 13, 2025 13:42

dvdksn approved these changes Jan 13, 2025

View reviewed changes

dvdksn merged commit d08fe30 into docker:main Jan 13, 2025
5 checks passed

Laravel + Docker guide #21276

Laravel + Docker guide #21276

Uh oh!

Conversation

rw4lll commented Oct 29, 2024 • edited by dvdksn Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues or tickets

Reviews

Uh oh!

netlify bot commented Oct 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docsdocker ready!

Uh oh!

dvdksn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rw4lll commented Oct 30, 2024

Uh oh!

rw4lll commented Oct 31, 2024

Uh oh!

dvdksn Nov 4, 2024

Choose a reason for hiding this comment

Uh oh!

rw4lll Nov 4, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dvdksn Nov 4, 2024

Choose a reason for hiding this comment

Uh oh!

rw4lll Nov 4, 2024

Choose a reason for hiding this comment

Uh oh!

dvdksn Nov 4, 2024

Choose a reason for hiding this comment

Uh oh!

dvdksn Nov 4, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rw4lll commented Dec 27, 2024

Uh oh!

dvdksn left a comment

Choose a reason for hiding this comment

Uh oh!

rw4lll commented Jan 10, 2025

Uh oh!

dvdksn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rw4lll commented Oct 29, 2024 •

edited by dvdksn

Loading

netlify bot commented Oct 29, 2024 •

edited

Loading