Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Template - Solution Description"

(Setup)
Line 12: Line 12:
  
 
===Functionality===
 
===Functionality===
- what is its functionality?
+
<what is its functionality?>
  
 
==Developer Perspective==
 
==Developer Perspective==
  
 
===Architecture===
 
===Architecture===
- component diagram
+
<component diagram>
- [flow diagrams]
+
<[flow diagrams]>
- list of components used
+
<list of components used>
  
 
===Building===
 
===Building===
- links to one or more pages to describe  
+
<links to one or more pages to describe  
 
   + how to get the source  
 
   + how to get the source  
   + how to build executables (jars, wars, exes, etc)
+
   + how to build executables (jars, wars, exes, etc)>
  
 
===Deploying===
 
===Deploying===
- links to one or more pages to describe  
+
<links to one or more pages to describe  
 
   + prerequisites  
 
   + prerequisites  
 
   + how to obtain the .WAR, etc.  
 
   + how to obtain the .WAR, etc.  
   + how to deploy and configure a complete working solution
+
   + how to deploy and configure a complete working solution>
  
 
== See Also ==
 
== See Also ==
* [[Deployments]]
+
* [[Solutions]]
  
 
== Links ==
 
== Links ==
 
* [http://eclipse.org/higgins Higgins Home]
 
* [http://eclipse.org/higgins Higgins Home]

Revision as of 15:20, 18 December 2007

This page is the template for Solution description page

For each DC there should be ONE top-level page that follows this template:

Introduction

<describe this solution>

End-User Perspective

Setup

<how do you use it?>

Functionality

<what is its functionality?>

Developer Perspective

Architecture

<component diagram> <[flow diagrams]> <list of components used>

Building

<links to one or more pages to describe

 + how to get the source 
 + how to build executables (jars, wars, exes, etc)>

Deploying

<links to one or more pages to describe

 + prerequisites 
 + how to obtain the .WAR, etc. 
 + how to deploy and configure a complete working solution>

See Also

Links

Back to the top