I agree that "official" should be dropped.
"Besides DDEV, other Docker-based Drupal tools exist for any OS but aren't officially recommended."
I have gone ahead and changed that summary to this:
"While DDEV is recommended, Drupal is supported by other Docker-based tools."
Not sure who would have control over the wording in the DDEV banner.
Changed summary from "Besides DDEV, other Docker-based Drupal tools exist for any OS but aren't officially recommended." to "While DDEV is recommended, Drupal is supported by other Docker-based tools." Discussion at https://www.drupal.org/project/documentation/issues/3499635#comment-1608... 📌 Review/archive the local server setup section Active .
Minor grammar and formatting corrections.
Setting to 'Needs work' following proposal by @sajosh at https://www.drupal.org/node/2743413/discuss#comment-16067428 → to pull various pages into this one. A review and overhaul is required (and possibly an issue to discuss it). Specific examples:
- The summary does not make sense.
- 'Locally' links to https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... → , but the above proposal requests to remove it.
Took the new explanations out of the code blocks (because they looked like they were comments in files) and expanded them a little.
Grammar corrections and improvements. Formatting improvements including removing the <em> tags from <code> snippets, and removing inconsistent spacing withing square brackets. Rephrasing.
Minor changes to capitalization, grammar, and formatting.
The DDEV section needed some reference to Docker before the final line, to add a little info and to make it logical, rather than rely on just the implication of "Install Drupal without Docker...". So I changed "Consistent environments" to "Consistent, Docker-based environments".
Change "Consistent environments" to "Consistent, Docker-based environments".
The "other options" are in the first two guides and they are all docker based.
These aren't all Docker-based:
- Installing Drupal on Windows for local usage
- Installing Drupal with DDEV in WSL2 on Windows
- Running on a USB Drive with USBWebserver
- Using XAMPP
I'm trying not to be pedantic. Just confused.
@nick hope, if you can improve the paragraph, go ahead. I think that type of change does not need to be discussed before changing it.
@quietone But I'm confused about the gist/point of those 2 sentences. Does "Other options" mean "alternatives to DDEV"? Is the intention to push people towards https://www.drupal.org/docs/getting-started/installing-drupal → if possible?
Also, while we're generally pushing people towards Installing Drupal, the first page in that guide, https://www.drupal.org/node/2799489/revisions/view/13365326/13925190#s-l... → , sends people back to https://www.drupal.org/docs/develop/local-server-setup → . So that needs addressing.
I'm happy to try and improve docs. Just want to make sure we're all on the same page with the intentions.
Are there any objections to deleting them?
Not from me.
OK, I have done that. Also, reworded the 1000 characters for this guide.
@quietone I modified it a little more ( https://www.drupal.org/docs/develop/local-server-setup → ).
I am puzzled by the sentence, Other options using Docker are given below. If you do not want to use Docker go over to Installing Drupal., because:
- Other options to what?
- It implies everything below is an option using Docker, which is isn't.
- "Installing Drupal" is a guide to refer to even if you do want to use Docker.
Corrected period to comma. Corrected 'no' to 'not'. Added "for Drupal development" to clarify what using a local server is recommended for.
Partial revert to correct "WSL2 is an open-source Docker Engine" (it isn't) and restore link to the Windows-specific Docker installation section of the DDEV docs. Grammar corrections.
Lower case 'm' in 'Module' in title, per convention.
Lower case 'c' in 'contribute' in title, per convention.
Lower case 'c' in 'contribute' in title, per convention.
https://www.drupal.org/docs/develop/local-server-setup/windows-developme... → has been redirected to https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... → . A couple of points:
1. Do we really want to redirect people straight to the DDEV page? It feels to me like we're pushing one solution too much at the exclusion of all others. I think it may be better to redirect to it's sibling, https://www.drupal.org/docs/develop/local-server-setup/windows-developme... → , where the user can at least see some options and find a link to https://bitnami.com/stack/drupal/virtual-machine, which is still a valid option for someone who does not want to use DDEV. Alternatively we could just redirect to their parent, https://www.drupal.org/docs/develop/local-server-setup/windows-developme... → .
2. https://www.drupal.org/docs/develop/local-server-setup/windows-developme... → still appears in menus. It needs "Provide a menu link" unchecking, but I can't find a way to edit it because of the redirect.
Modify the link to the Evaluator Guide. Split 'Goals' into 2 paragraphs.
Fix link to https://new.drupal.org/drupal-cms/trial.
Overhaul the page to update it, improve readability, reduce duplication. Add "Distributions" section to briefly explain the differences between Drupal CMS and Drupal Core. Split the structure by remote vs local testing. Capitalize "Core" (part of the name).
Modify the link to
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
to standardize it and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
Change "Finally" to "After installation".
I would be happy to be a maintainer of https://www.drupal.org/docs/getting-started/installing-drupal → . Specifically, in the short-term, I would like to be able to move https://www.drupal.org/docs/getting-started/installing-drupal/before-a-d... → to the first position in that guide (as explained on https://www.drupal.org/node/2799489/discuss → ).
This should be the first page in the parent guide, ahead of https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... → . That is its natural position, despite the consensus to promote DDEV, and I have rewritten it to be more appropriate for that purpose. I would be happy to be a maintainer of the parent guide ( https://www.drupal.org/docs/getting-started/installing-drupal → ) so I can make this change myself, and I will also request that role at https://www.drupal.org/project/documentation/issues/2682083 🌱 Recruiting guide maintainers for documentation Active .
Rewrite to make the page more logical, easier to read, and more appropriate for use as the first page in the 'Installing Drupal" guide.
Modify the DDEV note-tip to standardize it across the site and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
Modify the DDEV note-tip to standardize it across the site and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
Modify the link to
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
to improve its external and internal ranking for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
Modify the DDEV note-tip to standardize it across the site and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
- Split into 2 paragraph to visually differentiate the 2 links.
Modify the DDEV note-tip to standardize it and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
Modify the DDEV note-tip to standardize it and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
Modify the DDEV note-tip to standardize it and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
Modify the DDEV note-tip to standardize it and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
- Add link to
https://www.drupal.org/docs/develop/local-server-setup/windows-developme... →
.
Modify the DDEV note-tip to standardize it and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
Modify the DDEV note-tip to standardize it across the site and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
Modify the DDEV note-tip to standardize it across the site and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
Modify the DDEV note-tip to standardize it across the site and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
Modify the DDEV note-tip to standardize it across the site and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
Modify the DDEV note-tip to standardize it across the site and improve external and internal ranking for
https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... →
for searches, especially those including "local development":
- Use full new path as the link to the page.
- Use full description in the anchor text ("install Drupal using DDEV for local development").
- Remove `rel="nofollow"`.
Minor other changes to keep the description under the maximum permitted 1000 characters.
Capitalize 'Docker'. Add that the DDEV installation script will handle Docker installation if installing DDEV on Docker Engine on WSL2 on Windows.
Present nano and wslview as alternatives for editing files (since the previous document in the tutorial describes removing wslu/wlview for changing the default browser). Change DDEV documentation link from latest to stable.
Link to the DDEV Add-on Registry for finding add-ons. Change the DDEV documentation links from latest to stable.
Change note about uninstalling wslu again (for non-default browser usage). Only necessary if DDEV script is re-run; not after regular updating.
Remove guidance for installing wslu. DDEV installs it anyway, but with current versions of apps it now needs to be uninstalled if you wish a non-default browser to be opened by ddev launch. Also add a little more about reasons for recommending Zsh.
Rewrote the method for using a non-default Windows browser. A combination of current versions of WSL2/Ubuntu/DDEV/wslu/wslview always causes the $BROWSER variable to be set to wslview.desktop, which causes the default Windows browser to be used. Hence, wslu, installed by DDEV, needs to be uninstalled. Discussion at on the DDEV Discord server.
Change ddev get (deprecated) to ddev add-on get in 4 places. Thanks @fkelly12054@gmail.com.
I clarified the steps to reproduce in the issue summary a little.
Regarding #11, if it cannot be easily fixed, one potential solution is to disallow internal links. There is already a problem generating thumbnails for images added via internal links 🐛 Thumbnails not created for internal links Needs work .
Please comment below my comment #2 there 🐛 Thumbnails not created for internal links Needs work , or on this issue, if internal links are important to you and if you want to use locally-stored images with this module.
@senzaesclusiva I am also confused. Are you attempting to add a remote image (at /media/add/remote_image) without adding a URL in the "URL" field in the "Media Remote Image URL"?
Please fill in the "Steps to reproduce" section in the issue summary, so that it's clear.
I hope this can be fixed, but if it cannot, we should consider excluding internal links to images.
The original intent of this module was to add remote images using external links. While locally-stored images would normally be added using the core Image Media type, I suppose it may be useful for this module to support internal links as well, for example so that site builders can use just one media type for both their local and remote images, and multiple fields would not need duplicating on both media types.
That feels like an edge-case to me. Is anyone actually using internal links with this module? Does anyone need that functionality?
nick hope → created an issue.
I've updated MR !7 to fix the phpcs errors described in #8 and #14, and to change "Type the remote image url above." to "Enter the remote image URL." per #8.
Also attaching an updated patch (also available at https://git.drupalcode.org/project/media_entity_remote_image/-/merge_req...).
This does not fix #11, which I can confirm, so it still needs work. I think there are wider problems using internal URLs even without this patch, and may open a separate issue after further investigation.
Created MR and attaching patch, if anyone needs it (also available at https://git.drupalcode.org/project/media_entity_remote_image/-/merge_req...).
Add info about what is shown when you click "Create merge request".
Overhaul of the page. Rephrasing and reformatting for readability and clarity. Add detail on how to fill out the New merge request form on GitLab. This should be reviewed by those with expertise in the Drupal/GitLab workflow to check that the information I have given conforms to Drupal.org policy. For example, it's possible that some fields on the form should be left unchanged in all circumstances.
Integrate very brief summary of what a merge request is. Other tweaks for readability.
Add information about the option of creating a new branch along with an issue fork. Add details of which commands are shown under "Show commands". Numerous changes to phrasing and formatting to improve readability and clarity. Add suggestions to create a merge request after completing commits.
Overhaul of the page for readability. Add specific reference and link to GitLab. Revise summary.
Having made many edits to this guide and its child pages, I think it would be better for Obtaining Git access → to come before Configuring Git for Drupal → . I believe a guide maintainer would have to change the weights of those child pages.
For information, it may be worth adding a note-tip at the top of this page (which I can't edit):
If logged into Drupal.org, these Terms of Service may be accepted or declined at https://git.drupalcode.org/-/users/terms. Acceptance is required for Git access.
Overhaul of page to reflect current procedure. Many fixed links. Remove redundant and duplicate instructions and rephrase for accuracy and clarity. Remove out-of-date user profile screen shot. Remove reference to sandbox projects, which are deprecated. Remove list of terms and defer to the Terms of Service itself. Remove link to Randy Fay video, which is 13 years old and out of date.
At the bottom of #9 I wrote:
I do wonder whether the content of Installing Drupal on Windows for local usage → can be integrated into the parent Windows development environment → , to save one page.
I realise now that guides' descriptions are limited to 1000 characters max, which is quite limiting, so that wouldn't be possible.
Remove duplicate Attributes section, accidentally left in after previous edit. Remove http before patch-url to prevent meaningless link being automatically created.
Re-organize, re-order, re-format and re-phrase for accuracy and readability. Correct links.
Rephrase and add links while staying under 1000 character limit.
Overhauled the page. Corrected links. Updated screenshots. Re-ordered resources list. Added GitLab learning links. Replaced GitHub Learning Lab with GitHub Skills. Re-phrasing and grammar correction.
Change link to https://www.drupal.org/docs/develop/issues → and some minor changes.
nick hope → created an issue.
@senzaesclusiva Why were you trying to save a node without inserting a link to a remote image?
There is a merge request and patch on issue https://www.drupal.org/project/media_entity_remote_image/issues/3467675 🐛 Deprecated function: pathinfo(): Passing null to parameter #1 ($path) of type string is deprecated Active that addresses the problem by simply making the URL field required in media_entity_remote_image/config/install/field.field.media.remote_image.field_media_remote_image_url.yml
https://www.drupal.org/project/media_entity_remote_image/issues/3467686 🐛 Should not unset 'title' key in element array Needs review also seems to be caused by the same reason.
There is a merge request and patch on issue https://www.drupal.org/project/media_entity_remote_image/issues/3467675 🐛 Deprecated function: pathinfo(): Passing null to parameter #1 ($path) of type string is deprecated Active that addresses the problem by simply making the URL field required in media_entity_remote_image/config/install/field.field.media.remote_image.field_media_remote_image_url.yml
https://www.drupal.org/project/media_entity_remote_image/issues/3471458 🐛 D10.3.2 Error "The URL field is required when the field is specified" Active seems to be caused by the same reason.
The MR !9 (in #4) address the problem by simply making the URL field required.
This should also address these issues:
- https://www.drupal.org/project/media_entity_remote_image/issues/3467686 🐛 Should not unset 'title' key in element array Needs review
- https://www.drupal.org/project/media_entity_remote_image/issues/3471458 🐛 D10.3.2 Error "The URL field is required when the field is specified" Active
To me, this seems logical. I suppose someone might want to create a media entity as a placeholder, and add the URL later, but I doubt it.
@peachez Was it just an empty URL field that caused the problem? And why were you saving a media item without that value?
If anyone was able to get past the issue and actually create media remote image entities with empty URL fields, we could consider a hook_update_N() to populate empty URL fields with a placeholder value etc.. Does anyone have media remote image entities with empty URL fields?
Also uploading a patch for anyone who wants it.
After applying patch #2, on a D11.1 site I get the following error when I click "Create a new field" on "/admin/structure/media/manage/remote_image/fields":
The website encountered an unexpected error. Try again later.
AssertionError: "General" must be defined in MODULE_NAME.field_type_categories.yml in assert() (line 183 of core/lib/Drupal/Core/Field/FieldTypePluginManager.php).
Drupal\Core\Field\FieldTypePluginManager->getGroupedDefinitions() (Line: 131)
Drupal\field_ui\Form\FieldStorageAddForm->processFieldDefinitions() (Line: 80)
Drupal\field_ui\Form\FieldStorageAddForm->buildForm()
call_user_func_array() (Line: 528)
Drupal\Core\Form\FormBuilder->retrieveForm() (Line: 279)
Drupal\Core\Form\FormBuilder->buildForm() (Line: 73)
Drupal\Core\Controller\FormController->getContentResult()
call_user_func_array() (Line: 123)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 593)
Drupal\Core\Render\Renderer->executeInRenderContext() (Line: 121)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->wrapControllerExecutionInRenderContext() (Line: 97)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 183)
Symfony\Component\HttpKernel\HttpKernel->handleRaw() (Line: 76)
Symfony\Component\HttpKernel\HttpKernel->handle() (Line: 53)
Drupal\Core\StackMiddleware\Session->handle() (Line: 48)
Drupal\Core\StackMiddleware\KernelPreHandle->handle() (Line: 28)
Drupal\Core\StackMiddleware\ContentLength->handle() (Line: 32)
Drupal\big_pipe\StackMiddleware\ContentLength->handle() (Line: 116)
Drupal\page_cache\StackMiddleware\PageCache->pass() (Line: 90)
Drupal\page_cache\StackMiddleware\PageCache->handle() (Line: 48)
Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle() (Line: 51)
Drupal\Core\StackMiddleware\NegotiationMiddleware->handle() (Line: 36)
Drupal\Core\StackMiddleware\AjaxPageState->handle() (Line: 51)
Drupal\Core\StackMiddleware\StackedHttpKernel->handle() (Line: 709)
Drupal\Core\DrupalKernel->handle() (Line: 19)This issue on another module is probably helpful: https://www.drupal.org/project/time_field/issues/3477472 🐛 FieldItemBase category cannot be translatable Active
A couple of questions:
- Since it has been redirected, how would one now view https://www.drupal.org/docs/develop/development-tools/develop-on-windows → to see what was on it?
- How does one actually implement such a redirect? I couldn't see such a feature on a page I maintain. Are special privileges required?
Updated branch 3059845-1 to match the latest 2.x.dev code.
Added support for inline widget display compatible with Drupal 10.
Fixed the "Selected (X of Y):" text. I am not sure it was ever working in the inline version.
Made merge Request against 3.x branch: https://git.drupalcode.org/project/entity_reference_tree/-/merge_request...
The patch can be applied to version 2.4.0.
Regarding the proposed resolution to archive https://www.drupal.org/docs/develop/local-server-setup → and redirect it to https://www.drupal.org/docs/getting-started/installing-drupal/install-dr... → , I think there needs to be a parent/landing page that at least mentions and links to the various valid alternatives to DDEV. If https://www.drupal.org/docs/develop/local-server-setup → disappears, where would such a page be?
To address the concerns with Installing Drupal with DDEV in WSL2 on Windows → :
- As I created it, I am listed as the sole maintainer and consider myself still actively maintaining it. I plan to follow it, check it and update it later this year when I install everything on a new laptop.
- It is very difficult or even impossible to defer to a generic installing-Drupal-on-Linux/Ubuntu guide from a Windows/WSL2-specific guide. Despite them both being Linux, the installation procedures are different.
- It is broad, and I understand the argument to simplify it and make it less 'tutorialish', for example removing the zsh stuff, but at this stage it seems a pity to start dismantling it when it's actually a good and comprehensive guide to setting everything up nicely. Many Windows site builders are in very foreign territory when they get into Ubuntu and DDEV and need all the hand-holding they can get. It's no Acquia Dev Desktop! I found the process very challenging, which is partly why I wrote the guide.
- The Drupal best practice settings → page (the final page in the tutorial) is probably already 'cross-platform' (or could be made to be) and could live outside the guide, where it could be linked to from installation guides for each platform. It should certainly be reviewed by more experienced users than me, and there are probably more things that could be added to it. But I don't know where it should live or if any similar pages already exist.
- As well as, or instead of drupal.org, I should probably put the tutorial on YouTube, and/or somewhere more suited to tutorials.
Besides that, I think Set up local server using Bitnami Drupal Stack → can probably be deleted. Nobody's going to miss that, and there is a reference to its replacement in Installing Drupal on Windows for local usage → .
I do wonder whether the content of Installing Drupal on Windows for local usage → can be integrated into the parent Windows development environment → , to save one page.
@quietone Thank you for reverting your change on that page → . I have made a further tweak to explain that it is part of a larger tutorial, which should help guide users to start at the beginning. I hope that's OK and makes sense.
Explain that page is part of a parent tutorial. Remove a rel="nofollow" attribute.
The change @vetchneons made was on the 3.0.x branch. I merged that change into the 3467184-error-call-to and removed some code that was now redundant as a result of the change. I'm not experienced in the gitlab workflow so I hope I've done that correctly.
Uploading a patch corresponding to the MR !7 in #4 for use in a composer workflow.
nick hope → made their first commit to this issue’s fork.
This also affected me when I updated the Quick Tabs module from 8.x-3.0-alpha7 to 4.0.0 in D10.4.1. I solved it by manually enabling the js_cookie (JavaScript Cookie Library) module.
Correct link to Installing Drupal with DDEV in WSL2 on Windows tutorial and other minor changes.
Correct link to Installing Drupal with DDEV in WSL2 on Windows tutorial and other minor changes.
Correct link to Installing Drupal with DDEV in WSL2 on Windows tutorial and other minor changes.
Correct link to Installing Drupal with DDEV in WSL2 on Windows tutorial and other minor changes.
@quiteone To be frank, I thought it was fine as I had written it, but I do understand the wish to defer to a single source of documentation where possible to avoid redundancy/obsolescence. However, IMO, deferring to the documentation on ddev.readthedocs.io leads to a rather convoluted experience.
I think part of the problem is that I wrote Installing Drupal with DDEV in WSL2 on Windows → (the parent of this document) as a complete, 'hand-holding' tutorial, reflecting exactly what I went through myself to get everything set up nicely, because there is no comprehensive guide out there and it was really tough for me, but I guess Drupal Documentation isn't really for such tutorials. I need to find a home for this tutorial elsewhere (perhaps YouTube, when I next undertake the whole process on a new computer).
If the consensus is that the detail is superfluous and should be removed, I'll go along with it.