Stardust/ContributingDocumentation

Contributing Documentation to Stardust

Stardust Documentation Git Repository

To contribute to our Stardust documentation you need to check out the documentation git repository from the desired branch.

The documentation git repository is git.eclipse.org/c/stardust/org.eclipse.stardust.documentation.git.

Please refer to our Source Code and Contributing via Gerrit Wiki pages for details on how to clone and check out Stardust git repositories.

The Stardust documentation consists of several documentation plugins, which are linked to the main documentation. You can easily contribute to our documentation by adding or linking a custom documentation plugin.

If you already have a local documentation plugin you like to link into Stardust documentation, proceed with #Linking a Documentation Plugin to Stardust Documentation.

If you have documentation you like to put into a documentation plugin to be linked into Stardust documentation, you need to create a plugin project, in which you create or copy your documentation. Proceed with #Creating a new Documentation Plugin in that case.

Creating a new Documentation Plugin

Create a new plugin project:

1. Select New & Project & Plug-in Project

   
   
   

2. Click Next

3. Enter a project name, e.g. org.eclipse.stardust.docs.your_product

   
   
   

4. In the Location field enter the location of your checked out stardust/documentation followed by the plugin name.

   
   
   

5. Click Next

6. Select the Create a plug-in using one of the templates option

7. In the Available templates section select Plug-in with sample help content

   
   
   

8. Click Next

9. In the Sample Help Table of Contents dialog, select Primary and add an appropriate label.

   
   
   

Editing the Documentation Plugin

Now you see the new plugin in your workspace.

You find example html files added in the html folder. These files are linked from the toc.xml table of contents file and serve as examples to demonstrate the plugin structure and toc usage.

Remove the example html files and add your custom documentation. Edit the toc.xml and replace the topics with your custom documentation topics and subtopics

Linking a Documentation Plugin to Stardust Documentation

To link your documentation plugin to the Stardust Documentation, enter the following link_to entry to the top toc line:

link_to="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/toc.xml#additional_handbooks"

Style Guide

Please refer to the Eclipse Doc Style Guide for a general guide on Eclipse documentation styling.

To provide our Stardust documentation style, copy the following to the html folder of your documentation plugin: media:styles styles

This folder contains the carnot.css Stardust style sheet containing style classes for headers, lists etc. A subfolder images contains bullet images and the Stardust logo used in the first heading.