Update (or remove) content about downloading the .tar.gz versions of Drupal and contrib projects

Created on 15 August 2024, 4 months ago
Updated 3 September 2024, 4 months ago

There are numerous pages right now where we talk about downloading code from Drupal.org as .tar.gz files. Which, while technically still possible, is not the recommend approach. We should look at how we talk about it in the guide and at a minimum deemphasize it in favor of recommending Composer.

It's currently mentioned here:

This page should be updated to promote Composer instead of manually downloading core. Maybe just remove the information about manual downloads all together?

https://www.drupal.org/docs/user_guide/en/install-decide.html β†’

This page provides steps for downloading the core .tar.gz and using it ... it's still accurate ... but it's definitely not recommended. I think we should remove it in favor of being opinionated rather than comprehensive. The only possible scenario where this might be useful still is if you're trying to just download and install core for a quick trial. But there's ongoing work to replace even the need to do that as part of Starshot so ... I vote remove it.

https://www.drupal.org/docs/user_guide/en/install-manual.html β†’

These two pages talk about using the admin UI to install a module, however that feature is removed from Drupal 10.4 - https://www.drupal.org/node/3461934 β†’ - so we need to remove it from here. I think installation via Composer is the only recommended method right now. And we can circle back and make appropriate updates once Project Browser is included in core.

This page provides detailed instructions about how install a module or theme with Composer.

https://www.drupal.org/docs/user_guide/en/install-composer.html β†’

Proposed resolution

Remaining tasks

πŸ› Bug report
Status

Fixed

Version

11.0

Component

User Guide content

Created by

πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @eojthebrave
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN
  • Status changed to Needs review 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Here's my first attempt at updating this. I remove the content about using the Update Manager UI. Made the use of Composer more prominent. And opted to move instructions about how to start using Composer with a project that was originally created from the .tar.gz files to the page about dealing with manual installations and off the Composer instructions page so that it's closer to where someone would actually use it. And, will make it easier for us to potentially just delete that content all together in the future.

  • Status changed to Needs work 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States Amber Himes Matz Portland, OR USA

    I agree that the manual downloading instructions should be removed in favor of using Composer.

    I reviewed the MR and caught some typos and commas. After these changes are made, I think this is good to go.

  • Status changed to Needs review 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN
  • Status changed to RTBC 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States Amber Himes Matz Portland, OR USA

    Ship it!

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    Thanks for working on this!

    Adding related core issue.

  • Status changed to Needs work 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Another option would be to remove the content about using .tar.gz files completely. And focus on Composer only. Which seems like it might be a good idea given the issue linked by @quietone. 🌱 [meta] Deprecate tarballs, because they are incompatible with Composer-managed dependencies, Automatic Updates, Project Browser, and release managers' health Active . Which is recommending that for core at least the option to install Drupal via .tar.gz be removed.

    And while the option to use .tar.gz files for contrib might still exist it is not the recommended way so we shouldn't be promoting it.

    I'm going to work on an update to this MR that removes the manual install instructions completely. Anyone have objections?

  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    I agree @eojthebrave, it makes sense to remove content about using .tar.gz files completely and focus on Composer only, since the option to install tarballs was removed in Drupal 10.4 and Drupal 11 via πŸ“Œ Remove adding an extension via a URL Fixed .

  • Status changed to Needs review 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Okay I've made significant updates to the MR and it's ready for another review. This update:

    • Updates the pages about applying module and theme updates to remove the use of the Update Manager UI and only recommend using Composer. The Update Manager UI isn't really compatible with Composer, and long term we should stop recommending it and wait for Automatic Updates. This also required updating some screenshots.
    • Remove the content about installing core from a .tar.gz file completely.
    • Update the content about manually installing a module or theme that was previously about using a .tar.gz file to be about installing custom modules or themes that are no available via Composer.
  • Status changed to Needs work 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States Amber Himes Matz Portland, OR USA

    Thanks for the update, @eojthebrave! I've reviewed it again and just have some copy edit suggestions.

    Also, I just used the GitLab WebIDE to search for links to the deleted file, install-manual, but I'm not sure I trust that 100%. So just wanted to make sure that you searched and removed links to the file you deleted.

  • Status changed to RTBC 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Thanks for the review and copy edits.

    Also, I just used the GitLab WebIDE to search for links to the deleted file ...

    Yes, I did a search through all the English language source files and the string `install-manual` is no longer present in any of them.

  • Pipeline finished with Skipped
    4 months ago
    #259635
  • Pipeline finished with Skipped
    4 months ago
    #259642
  • Status changed to Fixed 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024