Deploying

Timothy Lethbridge edited this page Jun 14, 2016 · 3 revisions
Clone this wiki locally

Deploying

Deploying simply means ensuring that changes that have been committed and built are available for use.

Deploying is not the same as releasing. Releasing is means creating a checkpoint version of Umple and increasing the version number. Details on releasing are documented separately. Deploying is one of the steps of releasing.

UmpleOnline

The only thing that needs to be manually deployed are files in UmpleOnline. We call this promoting

You first commit the changed files after testing on your own local UmpleOnline.

Then on the server you run the script

  promoteuol test

This tells you the files that need to be deployed to the test Umpleonline at http://cruise.eecs.uottawa.ca/umpleonline/test/

If correct then you run

  promoteuol test go

You then test the changes in the test UmpleOnline

Finally you repeat the above two steps, but with the word 'real' instead of 'test' to deploy to the main UmpleOnline.

Note: The above won't add new directories, If the commit adds new directories you need to add them manually first, and also add them to the promoteuol script which is in the bin directory

Deploying the User Manual

The user manual is generated based on a set of simple text documents that allow you to provide a description of the language component, the basic syntax of the feature, and example umple code. This is then passed through a generator (umpledocs.jar) to create our HTML user manual.

Editing the User Manual

The user manual is located within trunk/build/reference

Organize the left hand table of content by editing the order.group file

And edit the individual pages by editing the .txt files

Here is an example user manual page

isA
Classes

@@description
Used to denote an inheritance relationship between two classes

@@syntax
isA [extendsName] ;

@@example

class Person
{
  name;
}

class Student
{
  isA Person;
  Integer number;
}
@@endexample

A page is comprised of the following

  • A title (in the example above, the title is isA
  • A group (e.g. Classes)
  • A brief description of the page (defined after @@description and takes any arbitrary HTML)
  • The language syntax (defined after @@syntax)
  • An Umple example (fined within @@example and @@endexample)

Only the title and group are mandatory, but you should also at least include a brief description.

Compiling Locally to HTML

To view the output, you will need to run umpledocs.jar against the directory. This has been wrapped within a ant task found within trunk/build.

Here is how to package the umple docs locally.

cd trunk/build
ant -Dmyenv=local -f build.umple.xml packageDocs

Deploy to Server

When you are satisfied with the look, commit your code. The server now deploys the user manual automatically

The manual is found at http://manual.umple.org

At the bottom left of each page is a link to the relevant source page in Github