Difference between revisions of "Publishing to JED"
From Joomla! Documentation
m (Security) |
m (removing edit links) |
||
| (18 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | __NOEDITSECTION__ | |
| − | This | + | This page complements the [http://extensions.joomla.org/tos Terms of Service (TOS)] for extensions developers. |
| − | Inclusion in the Joomla! Extensions Directory is a privilege, not a right | + | Inclusion in the Joomla! Extensions Directory (JED) is a privilege, not a right. Inclusion is at the sole discretion of the JED team and the Community Leadership Team (CLT). |
| + | A listing can be removed at any time at the discretion of the JED team without notice. | ||
==Your files== | ==Your files== | ||
| Line 10: | Line 11: | ||
* [[Extensions_GPL_notices|Extensions GPL notices]] | * [[Extensions_GPL_notices|Extensions GPL notices]] | ||
* [[Components:xml_installfile|Components:xml installfile]] | * [[Components:xml_installfile|Components:xml installfile]] | ||
| − | * [[Manifest_files|Joomla! | + | * [[Manifest_files|Joomla! Manifest Files]] |
* [[Setting_up_your_workstation_for_extension_development|Setting up your workstation for extension development]] | * [[Setting_up_your_workstation_for_extension_development|Setting up your workstation for extension development]] | ||
| Line 18: | Line 19: | ||
* [[JED_Entries_License_Checklist|JED Entries License Checklist]] | * [[JED_Entries_License_Checklist|JED Entries License Checklist]] | ||
| − | + | ====Can I submit non-GPL licensed extensions?==== | |
No. Since March 1st 2009, only Joomla! extensions licensed under the GNU GPL will be accepted into the JED. Read this [http://community.joomla.org/blogs/leadership/636-jed-to-be-gpl-only-by-july-2009.html blog post for more information] | No. Since March 1st 2009, only Joomla! extensions licensed under the GNU GPL will be accepted into the JED. Read this [http://community.joomla.org/blogs/leadership/636-jed-to-be-gpl-only-by-july-2009.html blog post for more information] | ||
| Line 37: | Line 38: | ||
===Extensions Security=== | ===Extensions Security=== | ||
| − | * Tutorial:[[ | + | * Tutorial: [[Securing Joomla extensions]] |
* FAQ: [[Security_and_Performance_FAQs#Joomla.21_Extensions|Security and Performance FAQs - Extensions Security]] | * FAQ: [[Security_and_Performance_FAQs#Joomla.21_Extensions|Security and Performance FAQs - Extensions Security]] | ||
| − | |||
==Your actions== | ==Your actions== | ||
| Line 48: | Line 48: | ||
'''Joomla! 1.0 compatible extensions''' - Since March 31st 2009, JED no longer accepts Joomla! 1.0 compatible-only extensions. | '''Joomla! 1.0 compatible extensions''' - Since March 31st 2009, JED no longer accepts Joomla! 1.0 compatible-only extensions. | ||
* Read the [http://community.joomla.org/blogs/community/629-jed-will-phase-out-joomla-10-extensions-in-june-2009.html announcement] | * Read the [http://community.joomla.org/blogs/community/629-jed-will-phase-out-joomla-10-extensions-in-june-2009.html announcement] | ||
| + | '''Joomla! 1.5/1.6/1.7 compatible extensions''' - Since April 1st, 2012, JED no longer accepts Joomla! 1.5/1.6/1.7 compatible-only extensions. | ||
| + | * Read the [http://community.joomla.org/blogs/leadership/1566-the-jed-and-version-support.html announcement] | ||
====Submission Checklists==== | ====Submission Checklists==== | ||
| Line 67: | Line 69: | ||
# has valid links: [http://docs.joomla.org/Extensions_distribution see how we can help in distribution]. | # has valid links: [http://docs.joomla.org/Extensions_distribution see how we can help in distribution]. | ||
# is downloadable by front-end/public/registered or guest user. | # is downloadable by front-end/public/registered or guest user. | ||
| − | # is | + | # use the JEDChecker tool to find common submission errors: [http://extensions.joomla.org/extensions/tools/development-tools/21336 JEDChecker] |
| − | # is | + | # is installs on Joomla! unless your submission is for Tools category. |
| + | # is installs and un-installs without error (please test it in different environments). | ||
| + | # has all versions marked attached to listing | ||
| + | # is compatible with the current supported Joomla! version | ||
| + | # you do not impose additional restrictions on the usage, distribution or modification of the extension | ||
| + | # does not require any type of 'key' to function (if you use a support/update key that calls home, it must be disabled by default - we highly recommend using the core Joomla updater released from version 1.6+ to avoid any issues) | ||
===Voting=== | ===Voting=== | ||
| Line 75: | Line 82: | ||
* those considered direct competition | * those considered direct competition | ||
* your own files | * your own files | ||
| + | * if you have been suspended previously for fraudulent voting | ||
This applies also to people directly related to you: family, colleagues, employees and partners. | This applies also to people directly related to you: family, colleagues, employees and partners. | ||
===Promoting=== | ===Promoting=== | ||
* Soliciting reviews and votes: Extensions may only solicit votes and/or reviews in the manner defined in the TOS | * Soliciting reviews and votes: Extensions may only solicit votes and/or reviews in the manner defined in the TOS | ||
| − | |||
==Users actions on your entries== | ==Users actions on your entries== | ||
| Line 89: | Line 96: | ||
==JED Categorization== | ==JED Categorization== | ||
===Can I suggest some changes to categorization?=== | ===Can I suggest some changes to categorization?=== | ||
| − | Categories in JED is constantly evolving to cope with the increasing amount of extensions. We strive to provide a good categorization to fit all extensions listed in JED. If you feel that an extension deserved to be in another existing or new category, please use the "Report This" button and let us know about your suggestion. You can also | + | Categories in JED is constantly evolving to cope with the increasing amount of extensions. We strive to provide a good categorization to fit all extensions listed in JED. If you feel that an extension deserved to be in another existing or new category, please use the "Report This" button and let us know about your suggestion. You can also open a support ticket. |
===Which category should I publish my extension?=== | ===Which category should I publish my extension?=== | ||
| Line 104: | Line 111: | ||
===Can I request an Extension Specific Category?=== | ===Can I request an Extension Specific Category?=== | ||
| − | Extension specific categories can be requested by a developer but are created at the sole discretion of the Joomla! Extensions Directory team and | + | Extension specific categories can be requested by a developer but are created at the sole discretion of the Joomla! Extensions Directory team and the CLT. |
| − | In general, extension specific categories are created when there are 5 or more extension specific listings for a | + | In general, extension specific categories are created when there are 5 or more published extension-specific listings for a parent extension created by developers. To request an extension-specific category, open a [http://extensions.joomla.org/component/maqmahelpdesk/ Support Ticket] and provide a link to the listings that would go into the new category. |
| − | Developers | + | Developers are welcome to create extension specific listings for other extensions. |
| − | |||
==Directory Rules== | ==Directory Rules== | ||
| − | Joomla! Extensions Directory [http://extensions.joomla.org/tos | + | Joomla! Extensions Directory [http://extensions.joomla.org/tos Terms of Service (TOS)] |
===Trademarks=== | ===Trademarks=== | ||
====Joomla! Trademark==== | ====Joomla! Trademark==== | ||
| Line 124: | Line 130: | ||
* FAQ: [[Why_does_the_Extensions_site_include_insecure_extensions%3F|Why does the Extensions site include insecure extensions?]] | * FAQ: [[Why_does_the_Extensions_site_include_insecure_extensions%3F|Why does the Extensions site include insecure extensions?]] | ||
* [http://community.joomla.org/blogs/community/1111-the-vel-reporting-procedure-explained.html The Vulnerable Extension List procedure explained] | * [http://community.joomla.org/blogs/community/1111-the-vel-reporting-procedure-explained.html The Vulnerable Extension List procedure explained] | ||
| − | ** Vulnerable Extensions List: [ | + | ** Vulnerable Extensions List: [http://vel.joomla.org] |
===Names and Alias=== | ===Names and Alias=== | ||
| Line 133: | Line 139: | ||
We support the original project developer whenever possible to maintain the integrity of the listings and also support developers who are building and innovating on the Joomla platform. To have a forked project listed in the JED it must meet additional requirements over original extension | We support the original project developer whenever possible to maintain the integrity of the listings and also support developers who are building and innovating on the Joomla platform. To have a forked project listed in the JED it must meet additional requirements over original extension | ||
* FAQ: [[Forked_Extensions|Forked Extensions]] | * FAQ: [[Forked_Extensions|Forked Extensions]] | ||
| − | |||
==JED Editors actions== | ==JED Editors actions== | ||
| Line 140: | Line 145: | ||
===Unpublishing=== | ===Unpublishing=== | ||
| − | When an entry | + | When an entry is unpublished, a note is displayed on the public page and an email is sent to the developer. You can contact the JED team via the [http://extensions.joomla.org/component/maqmahelpdesk/ Ticket Support System] to solve issues and get your extension republished. |
| + | |||
| + | See [http://extensions.joomla.org/index.php?option=com_content&id=53 Description of Unpublish Reason Codes (UR Codes)] for more information on how to solve issues with your listing. | ||
===Violations ans Suspensions=== | ===Violations ans Suspensions=== | ||
| − | See Terms of Service [http://extensions.joomla.org/tos | + | See Terms of Service [http://extensions.joomla.org/tos TOS, J- Violations] |
| − | |||
==JED Team Contact== | ==JED Team Contact== | ||
| − | * Forum to discuss issues [ | + | * Forum to discuss general issues [[jforum:262|JED Forum]] |
| − | * | + | * [http://extensions.joomla.org/component/maqmahelpdesk/ Ticket Support System] for listings (the JED does not handle listing support through email, only through our ticket support system) |
| − | |||
==Additional reading== | ==Additional reading== | ||
| − | * Directory TOS: [http://extensions.joomla.org/tos | + | * Directory TOS: [http://extensions.joomla.org/tos Terms of Service (TOS)] |
* GPL FAQ for extensions: [[Extensions_and_GPL|Extensions and GPL]] | * GPL FAQ for extensions: [[Extensions_and_GPL|Extensions and GPL]] | ||
* See more FAQs: [[Category:JED|JED additional Faq]] | * See more FAQs: [[Category:JED|JED additional Faq]] | ||
* Help: http://extensions.joomla.org/help2 | * Help: http://extensions.joomla.org/help2 | ||
| − | |||
| − | |||
[[Category:JED]] | [[Category:JED]] | ||
Revision as of 11:02, 29 May 2014
This page complements the Terms of Service (TOS) for extensions developers.
Inclusion in the Joomla! Extensions Directory (JED) is a privilege, not a right. Inclusion is at the sole discretion of the JED team and the Community Leadership Team (CLT).
A listing can be removed at any time at the discretion of the JED team without notice.
Your files
Coding
- Language Guidelines for 3rd Party Extensions
- Extensions GPL notices
- Components:xml installfile
- Joomla! Manifest Files
- Setting up your workstation for extension development
Licensing
Can I submit non-GPL licensed extensions?
No. Since March 1st 2009, only Joomla! extensions licensed under the GNU GPL will be accepted into the JED. Read this blog post for more information
Free or commercial?
- To select on business model see: Free and Commercial extensions
Naming
Packing
- Packing your extensions Extensions packing
- Extensions pack - general requirements
Distribution
Its important to have your files always a available to download
- See how we can help you distributing your file Extensions distribution
Extensions Security
Your actions
Submiting files
Extensions compatibility
Joomla! 1.0 compatible extensions - Since March 31st 2009, JED no longer accepts Joomla! 1.0 compatible-only extensions.
- Read the announcement
Joomla! 1.5/1.6/1.7 compatible extensions - Since April 1st, 2012, JED no longer accepts Joomla! 1.5/1.6/1.7 compatible-only extensions.
- Read the announcement
Submission Checklists
Your submission will be reviewed in a 4 steps process. Before you submit a file to JED you should also take the same steps to avoid delays in publishing:
- Step A - Submission Checklist
- Step B - Trademark Checklist
- Step C - License Checklist
- Step D - Installation and Functionality Checklist
How can I help to speed up my extension's approval time?
There are several ways you can help the extension submission process go faster and smoother. As you may know, the Joomla! Extension Directory is supported by volunteers and it takes time to go through all the extensions. You can help to speed up the approval process by making sure your extension:
- uses GPL license and include proper notices.
- follows Joomla's Logo and Brand guidelines.
- has permission to use Joomla trademark if your extension or site uses Joomla!'s trademark.
- if using Joomla word, its an approved name: see Form for name request .
- does not conflict with other extension names Extensions name FAQ
- has valid links: see how we can help in distribution.
- is downloadable by front-end/public/registered or guest user.
- use the JEDChecker tool to find common submission errors: JEDChecker
- is installs on Joomla! unless your submission is for Tools category.
- is installs and un-installs without error (please test it in different environments).
- has all versions marked attached to listing
- is compatible with the current supported Joomla! version
- you do not impose additional restrictions on the usage, distribution or modification of the extension
- does not require any type of 'key' to function (if you use a support/update key that calls home, it must be disabled by default - we highly recommend using the core Joomla updater released from version 1.6+ to avoid any issues)
Voting
You are not allowed to vote for extensions:
- on same category as your files
- those considered direct competition
- your own files
- if you have been suspended previously for fraudulent voting
This applies also to people directly related to you: family, colleagues, employees and partners.
Promoting
- Soliciting reviews and votes: Extensions may only solicit votes and/or reviews in the manner defined in the TOS
Users actions on your entries
Reviewers
How can I, as a developer, get in contact with this particular reviewer?
You can´t. Identity of JED users will never be revealed. What we can do is to invite a user to contact developer when developer wants to help out with an issue raised in reviews. Developer should then provide us with contact details, and then we will provide this information to the user.
JED Categorization
Can I suggest some changes to categorization?
Categories in JED is constantly evolving to cope with the increasing amount of extensions. We strive to provide a good categorization to fit all extensions listed in JED. If you feel that an extension deserved to be in another existing or new category, please use the "Report This" button and let us know about your suggestion. You can also open a support ticket.
Which category should I publish my extension?
If you are unsure where to publish your extension, a good starting point would be to look at other related extensions and find where they are listed.
Can I submit multiple listings at different categories for the same extension?
No. You are allowed to list your extension once in a category in JED.
Can I have my extensions listed at different categories?
No. Extensions can be listed in one category only.
What should I do if my extension is suitable to be listed in multiple categories?
We suggest that you use the Description field in your extension listing to communicate the suitability of your extension in other areas.
Can I request an Extension Specific Category?
Extension specific categories can be requested by a developer but are created at the sole discretion of the Joomla! Extensions Directory team and the CLT. In general, extension specific categories are created when there are 5 or more published extension-specific listings for a parent extension created by developers. To request an extension-specific category, open a Support Ticket and provide a link to the listings that would go into the new category. Developers are welcome to create extension specific listings for other extensions.
Directory Rules
Joomla! Extensions Directory Terms of Service (TOS)
Trademarks
Joomla! Trademark
The Joomla! name and logos are registered trademarks in the United States and elsewhere held by Open Source Matters. Permission, from OSM, to use these trademarks is usually required and is only granted subject to specific rules Trademarks Trademark Checklist
3rd party trademarks
- Protecting trademarks
- Name conflicts
Security Problems
When an extension its confirmed insecure it is unpublished from JED and listed at VEL (Vulnerable Extensions List)
- FAQ: How do you choose secure extensions?
- FAQ: Why does the Extensions site include insecure extensions?
- The Vulnerable Extension List procedure explained
- Vulnerable Extensions List: [1]
Names and Alias
Each entry gets its own ID. A name alias will be created for that entry
Forked extensions
We support the original project developer whenever possible to maintain the integrity of the listings and also support developers who are building and innovating on the Joomla platform. To have a forked project listed in the JED it must meet additional requirements over original extension
- FAQ: Forked Extensions
JED Editors actions
Rejecting
Unpublishing
When an entry is unpublished, a note is displayed on the public page and an email is sent to the developer. You can contact the JED team via the Ticket Support System to solve issues and get your extension republished.
See Description of Unpublish Reason Codes (UR Codes) for more information on how to solve issues with your listing.
Violations ans Suspensions
See Terms of Service TOS, J- Violations
JED Team Contact
- Forum to discuss general issues JED Forum
- Ticket Support System for listings (the JED does not handle listing support through email, only through our ticket support system)
Additional reading
- Directory TOS: Terms of Service (TOS)
- GPL FAQ for extensions: Extensions and GPL
- See more FAQs:
- Help: http://extensions.joomla.org/help2