Skip to content
Jean-Baptiste Sarrodie edited this page May 30, 2017 · 18 revisions

Welcome to the archi-modelrepository-plugin wiki!

While this plugin is still mainly a work in progress, you'll find here some useful informations...

Presentation

This plugin is an extension to Archi that provides collaborative features. It basically allows you to share a model on a repository and work on it with other users. It is built upon already existing Grafico plugin, so reading Grafico wiki can helps you understand how all this can work.

How it works

The cornerstone is the KISS. This basically means that we avoid reinventing the wheel and use Git to manage the hard stuff (branch management, diff/merge...). From a technical point of view, the model repository itself is nothing more than a Git server into which we will create one git repository per model (containing the model saved in the Grafico format). The plugin manages all the "plumbing" needed to provide a good user experience without requiring Git knowledge.

How to set it up

To install:

  • This plugin requires Archi version 4
  • Download and move the jar file into the "plugins" folder of your Archi 4 installation (Mac users will have to right click on the Archi.app and select "Show Contents" to access this folder)
  • Restart Archi
  • Select the "Window -> Reset Window Layout" menu option
  • The new plugin tab appears below the Models Tree

How to use it

Quick start:

  • Check out the new Preferences tab in Archi's Preferences dialog for global settings
  • You need to have a new empty git repository already setup on a git server
  • To add the model from the repository locally, select the first toolbar button in the plugin tab (the green cross). This will clone the repository and create a new blank model
  • Work as usual on your model and save it whenever you want
  • When you're ready to commit your changes, then choose "Commit Changes" (this can be done offline)
  • When you're ready to publish/share your work, then choose "Publish". In case of conflicts (same concept changed and published by someone else) you'll see a windows helping you to fix them.