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 "Template - Solution Description"

Line 5: Line 5:
  
 
==End-User Perspective==
 
==End-User Perspective==
 
+
<this section exists only if the solution has an end-user, e.g. Identity Selector>
===Setup===
+
<how do you use it?>
+
  
 
===Functionality===
 
===Functionality===
 
<what is its functionality?>
 
<what is its functionality?>
 +
 +
===Setup===
 +
<how do you install it?>
 +
 +
==Deployer Perspective==
 +
<this section exists only if the solution has a deployer, e.g. STS>
 +
 +
<links to one or more pages to describe...>
 +
 +
<..prerequisites>
 +
 +
===Download===
 +
<..how to obtain the .WAR, .jar, etc.>
 +
 +
===Deploying===
 +
<..how to deploy a complete working solution>
 +
 +
===Configuration===
 +
<..configuration files, options, etc.>
  
 
==Developer Perspective==
 
==Developer Perspective==
 +
<links to one or more pages to describe...>
  
 
===Architecture===
 
===Architecture===
<component diagram>
+
<..component diagram>
<[flow diagrams]>
+
 
<list of components used>
+
<..[flow diagrams]>
 +
 
 +
<..list of components used>
  
 
===Building===
 
===Building===
<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)>
+
  
===Deploying===
+
<..how to build executables (jars, wars, exes, etc)>
<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 ==
 
== See Also ==

Revision as of 15:55, 19 December 2007

This page is the template for Solution description page

Introduction

<describe this solution>

End-User Perspective

<this section exists only if the solution has an end-user, e.g. Identity Selector>

Functionality

<what is its functionality?>

Setup

<how do you install it?>

Deployer Perspective

<this section exists only if the solution has a deployer, e.g. STS>

<links to one or more pages to describe...>

<..prerequisites>

Download

<..how to obtain the .WAR, .jar, etc.>

Deploying

<..how to deploy a complete working solution>

Configuration

<..configuration files, options, etc.>

Developer Perspective

<links to one or more pages to describe...>

Architecture

<..component diagram>

<..[flow diagrams]>

<..list of components used>

Building

<..how to get the source>

<..how to build executables (jars, wars, exes, etc)>

See Also

Links

Back to the top