Problem/Motivation

Drupal.org has a number of pages related to using Composer to manage your Drupal site. These are all for the most part listed in the Using Composer guide.

The existing pages advise the use of the third-party components from drupal-composer/drupal-project. Once Drupal 8.8.0 reaches a sufficiently complete state, these documents should be updated to recommend the use of the components provided by Drupal core.

Existing documentation pages on Drupal 8.8.0 Composer:

Proposed resolution

Note that the tools provided by Drupal 8.8.0 (Drupal Composer Scaffold et. al.) may be used to manage Drupal 8.7.x sites and earlier. We may therefore update the documentation to recommend the new technique as a general solution.

Remaining tasks

Determine when is the best time to recommend using the new components. Alpha? Beta? Not until 8.0.0 stable?

Comments

greg.1.anderson created an issue. See original summary.

Mixologic’s picture

Mixologic
He/Him/His
Primary language English
Location Portland, OR
commented
Related issues: +#3000374: Improve Composer update workflow in UPDATE.txt

We should also review INSTALL.txt as it recommends using git to start a site, for example

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented

As far as the question in the issue summary, I would say "beta," at the latest. That's when we do a big push for community testing, and it'd be useful to have the "new and improved" recommended Composer steps in place by then so people could follow them and report any issues.

greg.1.anderson’s picture

greg.1.anderson commented

We should also discuss how to customize for alternate document roots, per https://github.com/drupal-composer/drupal-project/pull/527

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Priority: Normal » Major

Bumping priority of this, since it's quite important to do.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Version: 8.9.x-dev » 8.8.x-dev

Given scope and #3, this should target the 8.8.x branch.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented

Our project message Composer plugin says this at the end of creating a project, and we should make sure it's correct and appropriate:

                                                         
  Congratulations, you’ve installed the Drupal codebase  
  from the drupal/recommended-project template!          
                                                         

Next steps:
  * Install the site: https://www.drupal.org/docs/8/install
  * Read the user guide: https://www.drupal.org/docs/user_guide/en/index.html
  * Get support: https://www.drupal.org/support
  * Get involved with the Drupal community:
      https://www.drupal.org/getting-involved
  * Remove the plugin that prints this message:
      composer remove drupal/core-project-message
  * Homepage: https://www.drupal.org/project/drupal
  * Support:
    * docs: https://www.drupal.org/docs/user_guide/en/index.html
    * chat: https://www.drupal.org/node/314178
mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented

The vendor hardening plugin docs have been updated, and need moderation: https://www.drupal.org/docs/develop/using-composer/using-drupals-vendor-...

Once that happens, we can add them as related to the template docs page: https://www.drupal.org/docs/develop/using-composer/starting-a-site-using...

guillaumeduveau’s picture

guillaumeduveau
Location Toulouse
commented

Hi all,

The doc is a bit confusing ATM:

Also, I can see why Drupal wants to maintain https://github.com/drupal/recommended-project and https://github.com/drupal/legacy-project.

What I can't understand is why they are officially recommended by Drupal. They don't even have a README.

https://github.com/drupal-composer/drupal-project is light years ahead and should be officially recommended in my opinion.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Issue tags: +Needs documentation updates

Recommended-project and legacy-project emulate drupal-composer/drupal-project, to the point that drupal-project is essentially deprecated in favor of recommended-project.

Both of these project templates should have their own README, but they don't. The README is up one level, here: https://git.drupalcode.org/project/drupal/-/blob/8.8.x/composer/Template...

And here's an issue I just filed: #3144211: Add README.md to composer project templates

Recommended-project and legacy-project are recommended by Drupal because they are part of the Drupal core project, and are tested with core.

We should update https://www.drupal.org/docs/user_guide/en/install-composer.html to reflect recommended-project.

greg.1.anderson’s picture

greg.1.anderson commented
Title: Update Composer documentation once Drupal 8.8.0 is sufficiently ready » Update Composer documentation to match Drupal 8.8.0+ capabilities

The drupal-composer/drupal-project project has adopted the installation method of drupal/recommended-project, and also adds additional components / examples beyond what is in core, e.g. Drush. I therefore would not say that it is deprecated; it is still being maintained, and is still an option for folks to use as a starting point if they wish.

Recommended-project and legacy-project are recommended by Drupal because they are part of the Drupal core project, and are tested with core.

I agree that this should be part of our messaging.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone commented
Status: Active » Closed (outdated)

I skimmed the doc pages referred to in the issue summary and they have been updated. Therefor, closing this as outdated.

If that is incorrect re-open.