To Marketplace Developers: Let's fix INSTALL.TXT for concrete5.6 & 5.7 add-ons
Permalink
I've seen many people that still uses old install.txt that was originally made prior to concrete5.5. "Add Functionality" menu no longer exist since 5.5. So we should fix the install.txt as follows.
It's time to fix the sentences.
# For add-ons that support both concrete5.5~5.6 and later
----------
# Installation Instructions prior to version 5.5
1. Unzip this file in your site's packages/ directory.
2. Login to your site as an administrator.
3. Find the "Add Functionality" page in your dashboard.
4. Find this package in the list of packages awaiting installation.
5. Click the "install" button.
# Installation Instructions for version 5.5 and later
1. Unzip this file in your site's packages/ directory.
2. Login to your site as an administrator.
3. Find the "Extend concrete5" page in your dashboard.
4. Find this package in the list of packages awaiting installation.
5. Click the "install" button.
----------
For add-ons that only support concrete5.6 and later
----------
# Installation Instructions
1. Unzip this file in your site's packages/ directory.
2. Login to your site as an administrator.
3. Find the "Extend concrete5" page in your dashboard.
4. Find this package in the list of packages awaiting installation.
5. Click the "install" button.
------------
What do you think?
It's time to fix the sentences.
# For add-ons that support both concrete5.5~5.6 and later
----------
# Installation Instructions prior to version 5.5
1. Unzip this file in your site's packages/ directory.
2. Login to your site as an administrator.
3. Find the "Add Functionality" page in your dashboard.
4. Find this package in the list of packages awaiting installation.
5. Click the "install" button.
# Installation Instructions for version 5.5 and later
1. Unzip this file in your site's packages/ directory.
2. Login to your site as an administrator.
3. Find the "Extend concrete5" page in your dashboard.
4. Find this package in the list of packages awaiting installation.
5. Click the "install" button.
----------
For add-ons that only support concrete5.6 and later
----------
# Installation Instructions
1. Unzip this file in your site's packages/ directory.
2. Login to your site as an administrator.
3. Find the "Extend concrete5" page in your dashboard.
4. Find this package in the list of packages awaiting installation.
5. Click the "install" button.
------------
What do you think?
Good and useful suggestion.
Great idea, this is what I'm going to use for 5.7+
----------
# Installation Instructions
1. Upload and unzip this ‘package’ to your site's ‘packages/directory’.
2. Login to your site as an administrator.
3. Click on the ‘Dashboard’ icon, top right of page.
4. Click the ‘Extend concrete5’ link in open sidebar.
5. Find this package in the list of packages ‘Awaiting Installation’.
6. Click the ’install’ button.
----------
# Installation Instructions
1. Upload and unzip this ‘package’ to your site's ‘packages/directory’.
2. Login to your site as an administrator.
3. Click on the ‘Dashboard’ icon, top right of page.
4. Click the ‘Extend concrete5’ link in open sidebar.
5. Find this package in the list of packages ‘Awaiting Installation’.
6. Click the ’install’ button.
Hi
/**
* Concrete5 5.7+
* Package
* Installation Instructions
*/
1. Upload to site.
2. Unzip into packages.
3. Login as administrator.
4. Click dashboard menu, top right.
5. Click extend concrete5.
6. Click install.
---------------------------------------------------------------------
I would try to keep it as simple and neat as possible.
Since not all users are native English speakers, I would prefer to leave out articles and prepositions where possible. This way I believe English translates easier.
I think there is only one 'packages' directory so hopefully it's self explanatory.
Anyway, just my thoughts:)
LT
/**
* Concrete5 5.7+
* Package
* Installation Instructions
*/
1. Upload to site.
2. Unzip into packages.
3. Login as administrator.
4. Click dashboard menu, top right.
5. Click extend concrete5.
6. Click install.
---------------------------------------------------------------------
I would try to keep it as simple and neat as possible.
Since not all users are native English speakers, I would prefer to leave out articles and prepositions where possible. This way I believe English translates easier.
I think there is only one 'packages' directory so hopefully it's self explanatory.
Anyway, just my thoughts:)
LT
I believe the INSTALLL.TXT files are auto created when uploaded to the marketplace... for instance we do not add this file on upload but when downloading we can see this file has been added automatically.
Honestly this file should probably be pulled from the archives. I'm not
sure why it's there. There are tons of different places where we tell you
how to manually install packages on the site.
sure why it's there. There are tons of different places where we tell you
how to manually install packages on the site.
Not created if you include in package. I've updated an add-on with modified install.txt file and on download it shows mods.
Andrew, I understand that the text file could be pulled.
But, sometime, it's good to include the install.txt in the package.
People are sometime too dumb to search on the web.
Or we could simply include the URL in the install.txt.
Anyway, I just decided to make the post to the public because many add-on developers keep including the old install.txt.
But, sometime, it's good to include the install.txt in the package.
People are sometime too dumb to search on the web.
Or we could simply include the URL in the install.txt.
Anyway, I just decided to make the post to the public because many add-on developers keep including the old install.txt.
