No instructions exist for installing the extension in the download package
EXreaction opened this issue · comments
If you download the tag:
https://github.com/phpbb-extensions/boardrules/releases
There are no notes explaining what users should do. We should have something telling users where to copy files to or where they can go to learn how to install the extension if a tutorial exists somewhere.
I was thinking of having them with each release tag page, ie:
https://github.com/VSEphpbb/lightbox/releases
Or we could add a github wiki article for boardrules and link to that in each release tag ?
There are no general tutorials because the naming is very specific to each extension.
People probably will not take the time to read that page when they are
trying to just download it. I think an install instructions file would be
much more helpful as it's right there when needed.
On Wed, Jun 4, 2014 at 5:24 PM, Matt Friedman notifications@github.com
wrote:
I was thinking of having them with the download releases page, ie:
https://github.com/VSEphpbb/lightbox/releases—
Reply to this email directly or view it on GitHub
#119 (comment)
.
I think explaining how to install it in the topic on phpBB.com and in the README here on github would actually suffice, as that;s how all the other existing extensions are doing it right now.
Adding a file, like to a DOCs folder would be fine, and I even brought that up last week here only to be shot down by the same thing you just said - people won't read it. But also, we just tagged this, so we'd need to do another release if adding a new file to the package.
I've been trying for months to get the team members to come up with a consensus on how to communicate to extension downloaders effectively, to relay install instructions for example, and other useful info that traditionally would be found in a MOD's Author Notes and DIY sections... but never get any consensus 😢
Hmm.
Why do we not pepere ext for downloady->copy. I mean why boardrules folder is not a subfolder in phpbb. An user who downloads it, just need to unzip and copy the main folder to ext folder. That is the easiest way.
There was discussion/plans a while back that github repos may be used for installing directly to phpBB forums or to the Mod DB in which case the github user would be the vendor name and the repo would be the package, which is why many repos were setup like this one.
So create to 2 wiki pages: 1 for instalation, 2nd for updates. Or just one Instalation/update
I don't think anyone will read our wiki page here on github. That's why I recommend just putting it in the topic on phpBB and in the readme here.
As for general install instructions, there will be a page for that and everything else extension related added to phpBB soon.
Nobody would read wiki pages or even our readme here before they download and attempt to install an extension. However if there was a basic install instructions text file included that just said where to put the files and a link to another page for more in depth information, that would prevent people from just coming back to the support topic and saying it doesn't work.
And we don't really need a consensus from everyone else; think of it as an opportunity to lead the way to something better. ;)
We should really do all options available to us!
- Instructional file inside the extension package (although beta1 has already been made without such file)
- Instructions on Github's README page (for anybody who gets it from there)
- Instructions on the Ext in Dev forum where we link to the download, the most common place from where people will download this. Immediately following that download link should be the instructions on what to do to install it.
There is absolutely no reason not to have this info in as many places as possible. I know that's how I've done it, and I've had practically zero install help requests 😄
https://github.com/VSEphpbb/lightbox#installation
https://www.phpbb.com/community/viewtopic.php?f=456&t=2236221
Agreed
On Jun 5, 2014 9:20 PM, "Matt Friedman" notifications@github.com wrote:
We should really do all options available to us!
- Instructional file inside the extension package (although beta1 has
already been made without such file)- Instructions on Github's README page (for anybody who gets it from
there)- Instructions on the Ext in Dev forum where we link to the download,
the most common place from where people will download this. Immediately
following that download link should be the instructions on what to do to
install it.There is absolutely no reason not to have this info in as many places as
possible. I know that's how I've done it, and I've had practically zero
install help requests [image: 😄]
https://github.com/VSEphpbb/lightbox#installation
https://www.phpbb.com/community/viewtopic.php?f=456&t=2236221—
Reply to this email directly or view it on GitHub
#119 (comment)
.
Install instructions added to the community topic too.
This issue can be closed now.
Furthermore, when we have a contribution in the CDB we can have a stickied topic/FAQ