Jump to: navigation, search

Difference between revisions of "Development Resources/HOWTO/Conforming Incubation Branding"

(What is Conforming?: Added instructions about how to change the name of the downloadable file(s) and to update the Bundle-Names. Also, info about how to search for your project.)
 
(One intermediate revision by one other user not shown)
Line 10: Line 10:
 
# Correctly displays the same incubation logo on their project's primary download page.
 
# Correctly displays the same incubation logo on their project's primary download page.
 
# All downloadable zip files for builds and milestones must include the word "incubation" in the filename. For example, <code>DSF-SDK-incubation-N20070413-0200.zip</code>
 
# All downloadable zip files for builds and milestones must include the word "incubation" in the filename. For example, <code>DSF-SDK-incubation-N20070413-0200.zip</code>
 +
#* One way to do this is edit the <code>*.product</code> file(s) and add <code>.incubation</code> to the end of the <code>ID</code> field.
 
#* The jar files in the download zip file are not required to contain the word "incubation" in the filename. (See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=178944 bug 178944] for the explanation.)
 
#* The jar files in the download zip file are not required to contain the word "incubation" in the filename. (See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=178944 bug 178944] for the explanation.)
 
# All "Bundle-Name"s must include the word "incubation". Note that "Bundle-SymbolicName"s should not include "incubation" because the Bundle-SymbolicName is a technical namespace, not a user namespace. For example, <code>Bundle-Name: Foo Plug-in (Incubation)</code>
 
# All "Bundle-Name"s must include the word "incubation". Note that "Bundle-SymbolicName"s should not include "incubation" because the Bundle-SymbolicName is a technical namespace, not a user namespace. For example, <code>Bundle-Name: Foo Plug-in (Incubation)</code>
 +
#* One way to do this is: <code>sed -i .bak 's/\(^Bundle-Name:.*\)/\1 (Incubation)/' *yourproject*/META-INF/MANIFEST.MF</code>. Be aware that the sed command will add <code>(Incubation)</code> even if it is already present.
 
# Similarly, the names for update manager features must include the word "incubation". For example, <code>Eclipse Platform (Incubation)</code>
 
# Similarly, the names for update manager features must include the word "incubation". For example, <code>Eclipse Platform (Incubation)</code>
  
Projects are listed as conforming or non-conforming on the [http://www.eclipse.org/projects/listofprojects.php main /projects page] by the egg (conforming) and egg-with-red-slash (non-conforming) icons. If you believe your project is conforming (i.e., 1-5 above) but is listed as non-conforming, send email to emo@eclipse.org and ask us to update the database.
+
Projects are listed as conforming or non-conforming on the [http://www.eclipse.org/projects/listofprojects.php main /projects page] by the egg (conforming) and egg-with-red-slash (non-conforming) icons by searching for the project by name and then expanding the project by clicking on the name. If you believe your project is conforming (i.e., 1-5 above) but is listed as non-conforming, send email to emo@eclipse.org and ask us to update the database.
  
 
===Where to Place the Incubation Logo===
 
===Where to Place the Incubation Logo===
Line 40: Line 42:
 
<code>/images/egg-incubation.png</code>
 
<code>/images/egg-incubation.png</code>
 
</td></tr></table>
 
</td></tr></table>
 
  
 
''This page is moderated by the EMO''
 
''This page is moderated by the EMO''
 
[[Category:Development_Resources]]
 
[[Category:Development_Resources]]
 
[[Category:How to Contribute]]
 
[[Category:How to Contribute]]

Latest revision as of 14:20, 7 September 2016

Incubation Phase (Conforming) Branding

Why Should I Do This?

The Board of Directors has declared that all Incubation Phase projects clearly label themselves - this document describes how to do that. Incubation Phase projects that are correctly labeled are referred to as conforming and are allowed to participate in the Parallel IP process [1].

What is Conforming?

A conforming project:

  1. Is in the Incubation phase.
  2. Correctly displays the incubation logo on their project home page.
  3. Correctly displays the same incubation logo on their project's primary download page.
  4. All downloadable zip files for builds and milestones must include the word "incubation" in the filename. For example, DSF-SDK-incubation-N20070413-0200.zip
    • One way to do this is edit the *.product file(s) and add .incubation to the end of the ID field.
    • The jar files in the download zip file are not required to contain the word "incubation" in the filename. (See bug 178944 for the explanation.)
  5. All "Bundle-Name"s must include the word "incubation". Note that "Bundle-SymbolicName"s should not include "incubation" because the Bundle-SymbolicName is a technical namespace, not a user namespace. For example, Bundle-Name: Foo Plug-in (Incubation)
    • One way to do this is: sed -i .bak 's/\(^Bundle-Name:.*\)/\1 (Incubation)/' *yourproject*/META-INF/MANIFEST.MF. Be aware that the sed command will add (Incubation) even if it is already present.
  6. Similarly, the names for update manager features must include the word "incubation". For example, Eclipse Platform (Incubation)

Projects are listed as conforming or non-conforming on the main /projects page by the egg (conforming) and egg-with-red-slash (non-conforming) icons by searching for the project by name and then expanding the project by clicking on the name. If you believe your project is conforming (i.e., 1-5 above) but is listed as non-conforming, send email to emo@eclipse.org and ask us to update the database.

The Incubation logo is displayed in the right column of the web page, "above the fold" on a 1280x1024 display. The HTML to show the graphic is:

<div id="rightcolumn">
 ...
 <div class="sideitem">
   <h6>Incubation</h6>
   <div align="center"><a href="/projects/what-is-incubation.php"><img 
        align="center" src="/images/egg-incubation.png" 
        border="0" alt="Incubation" /></a></div>
 </div>
 ...
</div>

The Graphics

By community consensus, the incubating egg graphic has been chosen as the clear labeling required by the Board.

Egg-incubation.png

/images/egg-incubation.png

This page is moderated by the EMO