Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 322410 - [Documentation] Fix up Tigerstripe documentations
Summary: [Documentation] Fix up Tigerstripe documentations
Status: ASSIGNED
Alias: None
Product: Tigerstripe
Classification: Technology
Component: Documentation (show other bugs)
Version: unspecified   Edit
Hardware: PC Mac OS X - Carbon (unsup.)
: P3 normal (vote)
Target Milestone: 0.5M0   Edit
Assignee: Navid Mehregani CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 251417 (view as bug list)
Depends on:
Blocks:
 
Reported: 2010-08-11 13:30 EDT by Navid Mehregani CLA
Modified: 2010-12-06 15:23 EST (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Navid Mehregani CLA 2010-08-11 13:30:58 EDT
Build Identifier: 

There are some missing links and typos in Tigerstripe documentations.  Here are the things I found.  There is most likely more:

LINKS NOT WORKING:
	•	The Tigerstripe Instance Diagram Tutorial guides you through the first steps of creating an Instance Diagram with Tigerstripe.
	•	The Tigerstripe Shared Models Tutorial presents some advanced concepts about Tigerstripe Models.
	•	The Tigerstripe Facets Tutorial introduces how to leverage model Facets during code generation.
	•	The Tigerstripe UML Export Tutorial shows how to export a Tigerstripe project to UML.
	•	The Tigerstripe UML Import Tutorial shows how to import an existing UML file into a Tigerstripe project.


TYPOS:

http://wiki.eclipse.org/Tigerstripe_Hello_World: 
   "to make it work"
   This is the old way of installing plugins by unzipping into plugins folder

http://wiki.eclipse.org/Tigerstripe_Glossary: Tigerstripe glossary is empty!

http://wiki.eclipse.org/Tigerstripe_Simple_Plugin_Tutorial;
(Details of this syntax can be found be searching for Expander in teh on-line help).
"plug-in you just deployed will br present."
Make sure you have the project in scope and click Generate Image#Tigerstripe_generate_icon.gif.
The content of the file should look similar to the below image: NO IMAGE

http://wiki.eclipse.org/Tigerstripe_Plugin_Miscellany:
included in the <a href="velocityContextDetails.html">Default Velocity context</a> that you use to explode references.
""Runtine" tab of the plugin project descriptor."

http://wiki.eclipse.org/Tigerstripe_Simple_Model_Tutorial
  Session facade artifact icon is not there.
  This tutorial makes a reference to a demo tigerstripe plugin to generate output, but there is no discussion of where to obtain the demo plugin.
   Managed entity icon is outdated
  " Click the New Entity Artifact icon  in the toolbar. The New Entity Artifact dialog box appears.
Image:Tigerstripe new entity wizard.gif&#8730;Click the New Entity Artifact icon  in the toolbar. The New Entity Artifact dialog box appears.
Image:Tigerstripe new entity wizard.gif"
 "your project. (You can have many plugins enabled at the same time.)
Image:Tigerstripe generation details.gif"
 
  "NOTE THIS IS A DRAFT PAGE
   NOTE - THESE THREE PAGES TO BE DELETED…
  Document says to add a managed entity to a session facade through details tab.  However there is no details tab there.

http://wiki.eclipse.org/Tigerstripe_Class_Diagram_Tutorial:
Note: Not everything can be in this manner.

http://wiki.eclipse.org/Tigerstripe_Stereotypes_Tutorial:
Any Label - This means that the stereotype can be applied to any Attribute in any artifact in the model.
applied to Artifacts ofs pecific type.
mean that an stereotype 	
Click Add. The Stereotype Attribute Edit' dialog box opens.
Using Stereotypes from a plugin
To be completed
http://wiki.eclipse.org/Tigerstripe_Headless_Generation_Tutorial:
For more information on writing you own Tigerstripe Generators
eclipsec -nosplash -data

SUGGESTIONS: 
- A document to describe different artifact types and their purpose would be nice.

Reproducible: Always
Comment 1 Navid Mehregani CLA 2010-08-31 17:20:19 EDT
I took my first shot at this:

o Fixed up Simple Tigerstripe Model Tutorial
o Fixed up Simple Tigerstripe Plugin Tutorial
o Completed all the terms in Glossary.  This page had not been done before.
o Got rid of broken links
o Fixed up a lot of typos in tutorials
o Updated some of the images
Comment 2 Navid Mehregani CLA 2010-09-03 12:59:20 EDT
Downgrading this to normal, since most of the major issues have been addressed.
Comment 3 Navid Mehregani CLA 2010-12-06 15:23:12 EST
*** Bug 251417 has been marked as a duplicate of this bug. ***