Jump to: navigation, search

Difference between revisions of "OSEE/Documentation by view"

(Undo revision 194455 by Mark.db.zytek.co.uk (Talk))
Line 1: Line 1:
OSEE consists of an number of elements, which are described individually at [http://wiki.eclipse.org/OSEE#Documentation wiki.eclipse.org/OSEE#Documentation].
+
OSEE consists of an number of elements, which are described individually at [http://wiki.eclipse.org/OSEE#Documentation wiki.eclipse.org/OSEE#Documentation].  
  
 +
<br>
  
 +
However, one interacts with OSEE using a number of Eclipse views.
  
However, one interacts with OSEE using a number of Eclipse views.
+
<br>
  
 +
This section of the OSEE Wiki will be developed to describe these views and the common actions that are performed from them.
  
 +
<br>
  
This section of the OSEE Wiki will be developed to describe these views and the common actions that are performed from them.
+
The assumption is made that OSEE's ATS (Action Tracking System) will be used to provide lifecycle management. If you do not wish to use ATS then only some of the views described are relevant.  
  
 +
= Essential concepts  =
  
 +
=== Branches  ===
  
There will also be a Howto section that describes how to do something you may want to do without knowing which element of OSEE is doing it.
+
All work in OSEE is carried out on a branch. Development can be thought of as being like a tree. The trunk, called System Root branch in OSEE, is not visible to most users and is just there for the major branches to connect to.
 +
 
 +
Major branches are independent pieces of work, which may be separate products, product families, projects, etc. These branches then have their own sub-branches. At some level down the tree, users will have development branches on which they do their day-to-day work. These branches belong to the user(s) working on them and are not part of released development until they have been "committed" back to their parent.
 +
 
 +
e.g.
 +
 
 +
- Product 1 |
 +
 
 +
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Project x |
 +
 
 +
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; - My working branch
 +
 
 +
| &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; | &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; - Your working branch
 +
 
 +
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Project y |
 +
 
 +
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Fred's working branch
 +
 
 +
- Product 2 |
 +
 
 +
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Project z |
 +
 
 +
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Test release branch |
 +
 
 +
| &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Alf's working branch
 +
 
 +
|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Final release branch
 +
 
 +
- Hints and tips
 +
 
 +
|
 +
 
 +
- Lessons learned
 +
 
 +
<br>
 +
 
 +
= Essential OSEE Views  =
 +
 
 +
*ATS Navigator - the starting point for doing work
 +
*Artifact Explorer -
 +
 
 +
= Useful OSEE Views  =
 +
 
 +
*Branch manager

Revision as of 18:27, 30 March 2010

OSEE consists of an number of elements, which are described individually at wiki.eclipse.org/OSEE#Documentation.


However, one interacts with OSEE using a number of Eclipse views.


This section of the OSEE Wiki will be developed to describe these views and the common actions that are performed from them.


The assumption is made that OSEE's ATS (Action Tracking System) will be used to provide lifecycle management. If you do not wish to use ATS then only some of the views described are relevant.

Essential concepts

Branches

All work in OSEE is carried out on a branch. Development can be thought of as being like a tree. The trunk, called System Root branch in OSEE, is not visible to most users and is just there for the major branches to connect to.

Major branches are independent pieces of work, which may be separate products, product families, projects, etc. These branches then have their own sub-branches. At some level down the tree, users will have development branches on which they do their day-to-day work. These branches belong to the user(s) working on them and are not part of released development until they have been "committed" back to their parent.

e.g.

- Product 1 |

|                   - Project x |

|                   |                 - My working branch

|                   |                 - Your working branch

|                   - Project y |

|                   |                 - Fred's working branch

- Product 2 |

|                   - Project z |

|                                     - Test release branch |

|                                                                         - Alf's working branch

|                                                                         - Final release branch

- Hints and tips

|

- Lessons learned


Essential OSEE Views

  • ATS Navigator - the starting point for doing work
  • Artifact Explorer -

Useful OSEE Views

  • Branch manager