Installation instructions suggestions/feedback

Gert-dev / php-ide-serenata

Atom IDE package that integrates the Serenata server to provide PHP code assistance

https://serenata.gitlab.io/

Other

275 stars 19 forks source link

Installation instructions suggestions/feedback #447

Open ThomasLandauer opened 6 years ago

ThomasLandauer commented 6 years ago

Just some feedback and suggestion regarding the installation process:

In Atom's pop-up there's a button to test the setup for serenata. The test gave an OK for me, but the installation failed (mbstring extension was missing).
Please provide a way to resume a failed serenata installation. Since I didn't see any installation instructions at https://serenata.gitlab.io/ , I had to uninstall the php-ide-serenata package and re-install it again, only to kick-off serenata installation again.
Please provide separate installation instructions for serenata. Since (1) it needs lots of packages (and therefore takes a while) and (2) many users probably have composer already and know how to install something, a "manual" installation should be shown as alternative way.

Gert-dev commented 5 years ago

Thanks for the feedback!

Come to think of it, I think we can fix number one by running composer check, which should check for platform requirements. I've created #452 for this.

Regarding the second item: in theory if the installation fails and you restart Atom, the popup should show up again. I agree that being able to retry is a better solution, though. I've created #451 for this.

Finally, the installation instructions for Serenata can be found on its repository, but perhaps you meant being able to also specify an arbitrary path to a self-downloaded-and-installed Serenata?

ThomasLandauer commented 5 years ago

3: I was only looking at https://serenata.gitlab.io/ I think you should explain the installation process there too.
In general: Any installation where the user installs X, which silently installs Y, which silently installs Z is determined to produce failures, since as soon as any minor detail goes wrong, the user doesn't know anything on how to fix it. So I'd say it would be a step forward if you (somewhere) just showed the composer command which the php-ide-serenata package silently issues. Nothing fancy, just the basics... :-)