Document PIE as installation tool for Imagick. And remove PECL.

Open Beginner friendly
#23 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
php
Domain
documentation

Research direction

Start with the affected page, https://www.php.net/manual/en/imagick.installation.php, and verify the PIE installation guidance against the linked PHP RFC. Update the page to explain the ext-imagick composer.json requirement, PIE installation and PATH setup, and platform commands, while removing the PECL route; done means the Windows flow and available Linux guidance are clear.

Written by the indexing model from the issue text.

Description

enhancement
Affected page

https://www.php.net/manual/en/imagick.installation.php

Current issue

The current documentation refers to PECL. While the accepted PHP RFC: Recommend PIE and deprecate PECL states PIE is adopted formally as the recommended installation method for non-bundled PHP Modules and Zend Extensions.

Suggested improvement

The installation notes should be adjusted:

  • describe that composer.json (the requirement for PIE) must be adjusted.
{
    "require": {
        "ext-imagick": "3.8.1",
  • describe that the PIE installer must downloaded and put into the PATH.
  • (I'm on Windows, I don't known how the Linux works). describe the command for installing
pie-Windows-x64.exe install-extensions-for-project
Additional context (optional)

Background:

I had to install Imagick on Windows and this page was my starting point. Because there was no clear description I started the PECL route, downloading a zip containing lots of DLL's and trying to get that working. Well that did not work.

Then I saw the PIE notice. And I tried the PIE route. Well that was a smooth experience! The only confusion I had, was that the Imagick extension must be put in composer.json in the special format "ext-imagick".

Dominant language
XML
Stars
2
Forks
6
Avg merge
1d 14h
Merged PRs (30d)
5

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from php/doc-extensions

All issues in php/doc-extensions

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.