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.
Difference between revisions of "Template - Solution Description"
(New page: This page is the template for Solution description page For each DC there should be ONE top-level page that follows this template: ==Introduction== - what is this DC? ==End-User Perspe...) |
m (Solution Description Template moved to Template - Solution Description: reorganizing) |
||
(9 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{#eclipseproject:technology.higgins|eclipse_custom_style.css}} | ||
+ | [[Image:Higgins_logo_76Wx100H.jpg|right]] | ||
This page is the template for Solution description page | This page is the template for Solution description page | ||
− | |||
− | |||
==Introduction== | ==Introduction== | ||
− | + | <describe this solution> | |
==End-User Perspective== | ==End-User Perspective== | ||
+ | <this section exists only if the solution has an end-user, e.g. Identity Selector> | ||
+ | |||
+ | ===Functionality=== | ||
+ | <what is its functionality?> | ||
===Setup=== | ===Setup=== | ||
− | + | <how do you install it?> | |
− | === | + | ==Deployer Perspective== |
− | + | <This section exists only if the solution can be deployed independently, e.g. STS. In the event that the solution consists of executables that run in more than one process, then these "sub-systems" should link to separate pages that adhere to the following structure (for example, see [http://wiki.eclipse.org/Web-based_Selector_Solution#Deployer_Perspective here]> | |
+ | |||
+ | <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> | |
− | + | ||
− | + | <..[flow diagrams]> | |
+ | |||
+ | <..list of components used> | ||
===Building=== | ===Building=== | ||
− | + | <..how to get the source> | |
− | + | ||
− | + | ||
− | + | <..how to build executables (jars, wars, exes, etc)> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
== See Also == | == See Also == | ||
− | * [[ | + | * [[Solutions]] |
− | + | [[Category:Higgins Developer Info]] | |
− | + |
Latest revision as of 16:39, 25 April 2011
{{#eclipseproject:technology.higgins|eclipse_custom_style.css}}
This page is the template for Solution description page
Contents
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 can be deployed independently, e.g. STS. In the event that the solution consists of executables that run in more than one process, then these "sub-systems" should link to separate pages that adhere to the following structure (for example, see here>
<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)>