Metamodel-documentation < FESA

You are here: Foswiki>FESA Web>FESA3>FESA3Installation>Metamodel-documentation (03 Dec 2013, AlexanderSchwinn)Edit Attach

This page describes the steps which are needed to upload metamodel-documentation of a new release to the GSI-webserver

TODO: There is an Jira-Issue in order to ease this procedure: https://issues.cern.ch/browse/FESA-3508

Modify pathes in the following files:
- fesa-model/src/xml/design/docgen
  - search for "../../../core/design/docgen/pic" and replace it by "pic"
- fesa-model/src/xml/utility/docgen/html-generator
  - search for "../../../core/utility/docgen/documentation-style-sheet.css" and replace it by "documentation-style-sheet.css"
  - search for "file:../../../design/docgen/html/" and replace it by "file:"

Generate the documentation

      cd ~/workspace/fesa-fwk
      make clean-doc
      make create-doc

Copy all needed files to a single folder

      cd ~
      mkdir fesa-doc
      cp ../workspace/fesa-model-gsi/src/xml/design/docgen/html/design-doc.html fesa-doc
      cp ../workspace/fesa-model-gsi/src/xml/deployment/docgen/html/deployment-doc.html fesa-doc
      cp ../workspace/fesa-model-gsi/src/xml/instantiation/docgen/html/instantiation-doc.html fesa-doc
      cp ../workspace/fesa-model/src/xml/utility/docgen/documentation-style-sheet.css fesa-doc
      cp -r ../workspace/fesa-model/src/xml/design/docgen/pic fesa-doc

Check with some browser if everything looks ok (do the links between the documents work? Are the pics displayed ? Is the css active ? )
```
      firefox fesa-doc/design-doc.html &
```
Upload the files to the GSI webdav ( E.g. by using konquerror )
```
      konqueror webdavs://www.acc.gsi.de/dav &
```

Topic revision: r1 - 03 Dec 2013, AlexanderSchwinn

FESA

Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback