Documentation takes too much for granted

[stefanoborini]

The code and the overall aspect of the application is great, but the documentation is not clear enough to reach a simple starting point. There's no clear explanation of the bridges and what you have to do to make them run. I think that basic instructions to perform a successful "clean room" deployment is needed, especially if you don't have experience at all in web development.

For example, it's not clear how I should configure a simple web server to serve this application like in the demo, starting from a plain ubuntu installation. That would make clear which components are needed and what basic setup would kickstart the application.

It is also not clear that you need an ftp server installed on the machine, nor it's clear how to configure the php handler with the appropriate credentials, or how to use the php-local instead.

[durasj]

Hi @stefanoborini,

I agree that the documentation could be better and some out-of-the-box working configuration would be in my opinion preferable.

@joni2back I am quite busy, but I think I could ie. rewrite the default configuration so that it would use local bridge and would be fully preconfigured so the user would only upack the archive and open the manager in the browser. I would also add some instructions how to change the files directory. Not sure about FTP bridge though, not too familiar with it and I don't have any local FTP server by hand. What do you please think?

EDIT: @joni2back I am also thinking about adding one more property to config called 'bridgeUrl' which would be used as default/fallback URL if no specific _action_Url would be found as that would greatly reduce the effort for users to switch the bridge and any errors during it. Something like values.listUrl = 'bridges/php/handler.php' || values.bridgeUrl; for all action urls.

Thank you

[durasj]

Hi guys,

if anyone is following this thread or will stumble upon this, I created a bundle which should work out-of-the-box, also with short instructions and some common questions and answers.

Here it is: bundle-php-local

Hopefully, it will help somebody