Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add global installation instructions for Composer #1545

Closed

Conversation

kix
Copy link

@kix kix commented Apr 27, 2015

It's quite common for a tool like phpDocumentor to be installed globally.

The existing per-project instructions have been updated, too. Also note that they suggest to use composer require --dev, as this is the most common case of installation, in my opinion.


Installing phpDocumentor using Composer_ is a matter of creating a directory to host your files and executing the
following command::
To install phpDocumentor with Composer_ globally, exeute the following command::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For 'exeute' I think you meant 'execute'?

@kix kix force-pushed the add-composer-global-instructions branch from 67bdbec to 29935cd Compare April 27, 2015 19:57
@kix
Copy link
Author

kix commented Apr 27, 2015

@drbyte, is the PR overall good though?

@drbyte
Copy link
Contributor

drbyte commented Apr 27, 2015

I was just pointing out the typos so you could address them before the project leads review the PR.

It's debatable whether your changes are too specific to linux/mac, vs also adding stuff for Windows environments is necessary, vs merely adding a link to Composer's site about configuring paths/etc.

But it's not my call at all. I was just being pedantic about typos! LOL

@kix
Copy link
Author

kix commented Apr 27, 2015

@drbyte, well, thanks a lot, anyways (I should've noticed these two stupid typos myself)
By the way, the instructions basically assume a Unix-based environment with composer in PATH anyways, so I think it fits good with the rest of the docs.

@kix
Copy link
Author

kix commented May 4, 2015

The build failure is totally unrelated to the subject of this PR.

@mvriel
Copy link
Member

mvriel commented May 12, 2015

Hello @kix,

My apologies for not responding sooner; I have been ill for some time. At this moment I do not think it is wise to document this as this will give a signal that we officially support a global installation with Composer.

Since we are already supporting a fair amount of installation methods and we cannot guarantee that there will be no version conflicts when installing globally it is best to leave this option for advanced users who know how to do it and how to solve any issues that may arise.

I am sorry that this means that I will have to reject your contribution; I hope you understand my reasons for doing so.

With kind regards,

Mike

@mvriel mvriel closed this May 12, 2015
@kix
Copy link
Author

kix commented May 12, 2015

@mvriel, OK, no problem, sure. Although I'd really like to see PHPDocumentor as a globally installable package once.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants