Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Swordfish Documentation"

(How Tos: Fixed title saying to run the target platform outside 'ODE' instead of 'IDE'.)
 
(55 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{#eclipseproject:rt.swordfish}}
+
Here is a list of all the types of Swordfish User Documents that this project maintains
 +
<br>
 +
==Documentation Overview==
 +
[[Image:swordfish_community_user_doc2.png]]
 +
<br>
 +
===End Users===
 +
The information here is aimed at end users of the Swordfish project.
 +
If you have any feedback with regards to the content and usage of the documents, contact the Swordfish project team.
  
= Getting around the fish =
+
===Contributors and Commiters===
[[Image:Swordfish_smaller_logo.png‎ ]]
+
The information here is aimed at end users of the Swordfish project. If you are a project committer or contributor, see
 +
[[Contributor_User_Documentation| Contributors User Documentation]].
  
How to get to the full list of all Eclipse project pages: [http://www.eclipse.org/projects/listofprojects.php| List of all Eclipse projects].
+
==Whitepapers==
 +
http://www.eclipse.org/swordfish/assets/whitepaper.pdf
 +
==API Documents==
 +
<ul>
 +
<li>[http://www.eclipse.org/swordfish/docs/apidocs/ API Documents in Javadoc format]</li>
  
How to get back to the Eclipse Swordfish Project Summary Page: [http://www.eclipse.org/projects/project_summary.php?projectid=rt.swordfish| Swordfish Project Summary Page]<br>
+
</ul>
 +
==Concepts==
 +
[[Swordfish_Documentation:_Registry_Interface|Service Registry Interface]]
 +
==How Tos==
 +
<ul>
 +
<!--
 +
<li>[[Swordfish_Documentation:_Installing_BPEL_Designer_in_Galileo|Installing BPEL Designer in Galileo]]</li>
 +
<li>[[Swordfish_Documentation:_Executing_BPEL|Executing BPEL Processes]]</li>
 +
<li>[[Swordfish_Documentation:_Designing_BPEL_Eclipse_BPEL_Designer|Designing a BPEL Process with Eclipse BPEL Designer]]</li>
 +
-->
 +
<li>[[Swordfish_Documentation:_Launching_Service_Registry|Launching the Service Registry]]</li>
 +
<li>[[Swordfish_Documentation:_Running_Target_Platform|Running the Target Platform ]]</li>
 +
<li>[[Swordfish_Documentation:_Running_Target_Platform_Outside_An_IDE|Running the Target Platform Outside an IDE]]
 +
<li>[[Swordfish_Documentation:_Installing_ODE|Installing the ODE Engine ]]</li>
 +
<li>[[Swordfish_Documentation:_Setting_Up_Registry_From_Galileo_Update_Site|Setting up the Registry from the Galileo Update Site]]</li>
 +
<li>[[Swordfish_Documentation:_Generating_Dynamic_WSDL|Generating Dynamic WSDL]]</li>
 +
<li>[[Swordfish_Documentation:_Creating_JAX-WS_Client|Creating the JAX-WS Client]]</li>
 +
<li>[[Swordfish_Documentation:_Flight_Reservation_Tutorial|Flight Reservation Tutorial]]</li>
  
<h4>What are Eclipse Project Summary Pages?</h4>
+
</ul>
It is the entry point to the project. This page contains mostly information about the project organization, its roadmap and project timelines.
+
<!--== Registry Interface documentation ==
 +
[[Swordfish_Documentation:_registry_interface| Registry Interface]]-->
  
 +
==Frequently Asked Questions==
 +
[http://www.eclipse.org/swordfish/learn/faq.php FAQ]
  
<div style="margin:10px;background-color:#e0e0ff;border:1px solid blue;padding:20px;">
+
==Troubleshooting==
<h1>The Big Picture</h1> <br>
+
[[Swordfish_Documentation:_Troubleshooting | Target Platform bundles are not selected in the Run Configuration dialog]]
The [[Swordfish_Documentation:_Architecture| Architecture]] page contains sketches and conceptual information on the
+
Swordfish Runtime Framework Project and its components.
+
</div>
+
  
 
+
-------------------------------
 
+
[[Swordfish | Swordfish Wiki Home]]
<div style="margin:10px;background-color:#e0e0ff;border:1px solid blue;padding:20px;">
+
<h1>Swordfish for Developers</h1><br>
+
<table><tr><td>Swordfish List of Features</td><td>Development Stage</td>
+
</tr></table>
+
</div>
+
[[User:Anne.aloysious.sopera.de|Anne.aloysious.sopera.de]]
+
 
+
== Features for Galileo ==
+
See [[Swordfish_Documentation:_Product_Backlog | Swordfish Product Backlog]] for the list of features.<br/>
+
See the [[Swordfish_Documentation:_Sprint_Plan| Swordfish Sprint Planning]] page for sprint timelines and realization state of features. <br/>
+
All source code which is produced for swordfish should comply with [[Swordfish:ProjectRules:CoDoD | common definition of done]] <br/>
+
We have defined generic [[Swordfish_Documentation:_Feature_Completenes_Definition | feature completeness criteria]].
+
 
+
== API documentation ==
+
[http://www.eclipse.org/swordfish/docs/apidocs APIDOCS]
+
 
+
== Registry Interface documentation ==
+
[[Swordfish_Documentation:_registry_interface| Registry Interface]]
+
 
+
== Related project/technologies ==
+
 
+
Related projects/technologies which are used (could be interesting) in combination with Swordfish / Swordfish tooling
+
 
+
* OSGi, Eclipse Equniox
+
* Sprint DM
+
* Apache ServiceMix 4.0
+
* Apache CXF as JAX-WS Compatible runtime
+
* Eclipse Modeling Framework
+
* Eclipse SOA Tools projects
+
* http://wiki.eclipse.org/Servus
+
* Eclipse Web Tools project
+
* Eclipse SWTBot
+
* JAX-WS
+
 
+
= User documentation =
+
 
+
The user documentation is still missing. Please stay tuned!
+
[[Swordfish_Documentation:_User_Documentation|User Documentation]]
+

Latest revision as of 06:54, 20 May 2010

Here is a list of all the types of Swordfish User Documents that this project maintains

Documentation Overview

Swordfish community user doc2.png

End Users

The information here is aimed at end users of the Swordfish project. If you have any feedback with regards to the content and usage of the documents, contact the Swordfish project team.

Contributors and Commiters

The information here is aimed at end users of the Swordfish project. If you are a project committer or contributor, see Contributors User Documentation.

Whitepapers

http://www.eclipse.org/swordfish/assets/whitepaper.pdf

API Documents

Concepts

Service Registry Interface

How Tos

Frequently Asked Questions

FAQ

Troubleshooting

Target Platform bundles are not selected in the Run Configuration dialog


Swordfish Wiki Home

Back to the top