bug 544661: [CDO] CDO documentation must be completed
- this patch just write new documentation, the inclusion to the build will be done by another patch on another bug
Change-Id: I460716cd8ee14d4c4b8fb880664f55dcf04150c4
Signed-off-by: Vincent Lorenzo <vincent.lorenzo@cea.fr>
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/.project b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/.project
index 7210313..1d53539 100755
--- a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/.project
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/.project
@@ -6,21 +6,11 @@
</projects>
<buildSpec>
<buildCommand>
- <name>org.eclipse.jdt.core.javabuilder</name>
- <arguments>
- </arguments>
- </buildCommand>
- <buildCommand>
<name>org.eclipse.pde.ManifestBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
- <name>org.eclipse.pde.SchemaBuilder</name>
- <arguments>
- </arguments>
- </buildCommand>
- <buildCommand>
<name>org.eclipse.m2e.core.maven2Builder</name>
<arguments>
</arguments>
@@ -51,7 +41,6 @@
<natures>
<nature>org.eclipse.m2e.core.maven2Nature</nature>
<nature>org.eclipse.pde.PluginNature</nature>
- <nature>org.eclipse.jdt.core.javanature</nature>
<nature>org.eclipse.oomph.version.VersionNature</nature>
<nature>org.eclipse.pde.api.tools.apiAnalysisNature</nature>
</natures>
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/build.properties b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/build.properties
index a17ae1c..1e767a7 100755
--- a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/build.properties
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/build.properties
@@ -3,7 +3,9 @@
about.html,\
plugin.properties,\
plugin.xml,\
- target/generated-eclipse-help/**
+ target/site/generated-eclipse-help/**,\
+ target/generated-eclipse-help/**,\
+ resource/,\
+ src/
bin.excludes = **/*.markdown
-src.includes = about.html,\
- resource/
+src.includes = about.html
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Checkout.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Checkout.png
new file mode 100755
index 0000000..c9307b1
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Checkout.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_CloseServer.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_CloseServer.png
new file mode 100755
index 0000000..e19f4e9
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_CloseServer.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_CreateANewPapyrusModel.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_CreateANewPapyrusModel.png
new file mode 100755
index 0000000..8c6a7cc
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_CreateANewPapyrusModel.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Manage_Security.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Manage_Security.png
new file mode 100755
index 0000000..4706a3a
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Manage_Security.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Manage_Security_Editor.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Manage_Security_Editor.png
new file mode 100755
index 0000000..98dd263
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Manage_Security_Editor.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_NewRepository_0.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_NewRepository_0.png
new file mode 100755
index 0000000..50de5c0
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_NewRepository_0.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_NewRepository_1.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_NewRepository_1.png
new file mode 100755
index 0000000..5f28ac1
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_NewRepository_1.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_NewRepository_2.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_NewRepository_2.png
new file mode 100755
index 0000000..6f67da3
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_NewRepository_2.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Papyrus_User_Creation1.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Papyrus_User_Creation1.png
new file mode 100755
index 0000000..cee76af
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Papyrus_User_Creation1.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Papyrus_User_Creation2.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Papyrus_User_Creation2.png
new file mode 100755
index 0000000..ee64024
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Papyrus_User_Creation2.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Server_Disconnect.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Server_Disconnect.png
new file mode 100755
index 0000000..161da15
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Server_Disconnect.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Start_Server.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Start_Server.png
new file mode 100755
index 0000000..baa4b5d
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/CDO_Start_Server.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/OpenCDOExplorerPerspective.png b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/OpenCDOExplorerPerspective.png
new file mode 100755
index 0000000..e615a5e
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/images/OpenCDOExplorerPerspective.png
Binary files differ
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/papyrus-cdo-userDoc-start-main-toc.xml b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/papyrus-cdo-userDoc-start-main-toc.xml
new file mode 100755
index 0000000..2586f35
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/papyrus-cdo-userDoc-start-main-toc.xml
@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc label="UsingCdo" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocCustom">
+ <topic label="Using cdo" >
+ <topic label="General CDO">
+ <link toc="target/site/generated-eclipse-help/papyrus-cdo-userDoc-start-toc.xml"/>
+ <anchor id="cdoUserDoc"/>
+ </topic>
+
+
+ </topic>
+
+</toc>
diff --git a/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/papyrus-cdo-userDoc-start.mediawiki b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/papyrus-cdo-userDoc-start.mediawiki
new file mode 100755
index 0000000..27627bd
--- /dev/null
+++ b/cdo/bundles/org.eclipse.papyrus.cdo.ui.doc/src/site/mediawiki/papyrus-cdo-userDoc-start.mediawiki
@@ -0,0 +1,63 @@
+This documentation describes how to start working with the default PapyrusCDOServer.
+=How to install and launch PapyrusCDOServer on localhost=
+#Download the last version of the PapyrusCDOServer on '''https://hudson.eclipse.org/papyrus/view/Collaborative%20Modeling/job/Papyrus-CDO-Server/ws/products/'''
+#Unzip it
+#Run PapyrusCDOServer like done on this snapshot.
+#:[[File:images/CDO_Start_Server.png|frame|none|]]
+#:The CDO server is now launched and you have access to a OSGI terminal.
+
+
+The database is created in a ''develop'' folder at the root of your system.
+
+=How to connect to it from Papyrus=
+#Add in your Eclipse update site, this CDO interim job : '''https://download.eclipse.org/modeling/emf/cdo/drops/I20190208-0100'''
+#Install the last version of Papyrus CDO Integration ('''https://hudson.eclipse.org/papyrus/job/Papyrus-CDO/lastSuccessfulBuild/artifact/repository/''')
+#Restart Eclipse
+#Open the '''CDO Explorer''' Perspective
+#Add a new repository from the '''CDO Repository''' View by '''Click''' on the green plus
+#:[[File:images/CDO_NewRepository_0.png|frame|none|]]
+#a new dialod opens, Select '''Connect To an existing remove repository''' then '''Next''',
+#:[[File:images/CDO_NewRepository_1.png|frame|none|]]
+#Edit the fields with these values:
+#*''Host'': localhost
+#*''Port'': 2036
+#*''Repository name'': PapyrusCDOSecuredRepository
+#*''User name'': Administrator
+#*''Password'': 0000
+#*:[[File:images/CDO_NewRepository_2.png|frame|none|]]
+
+
+=How to create a new Papyrus model on this server=
+#Do a Checkout from your newly created repository
+#*:[[File:images/CDO_Checkout.png|frame|none|]]
+#In the project explorer, you now have a new folder called ''Online Transactional Checkout''. In it, find the home folder corresponding to your user id (here, it is ''Administrator'', select it, then '''Right-Click'''->'''New'''->'''Papyrus model'''.
+#*:[[File:images/CDO_CreateANewPapyrusModel.png|frame|none|]]
+#Now you can work according to your Papyrus habits
+
+''Note'': The commit on the CDO server is automatically done by the standard save action (CTRL-S).
+
+
+=How to Add User=
+#From the '''CDO Repository''' view, select your server, then '''Right-Click'''->'''Manage Security'''.
+#:[[File:images/CDO_Manage_Security.png|frame|none|]]
+#The '''CDO Security Manager''' editor is now open.
+#:[[File:images/CDO_Manage_Security_Editor.png|frame|none|]]
+#'''Click''' on the button in the top right corner to open a Tree Editor with the same information, then expand all contents, select the ''Users'' folder, then '''Right-Click'''->'''Papyrus CDO User Management'''->'''Create User'''. A dialog opens (after some delay the first time).
+#:[[File:images/CDO_Papyrus_User_Creation1.png|frame|none|]]
+#In this dialog, you can edit various informations about the new user (some values are already initialized by Papyrus). The required values are the ''ID'' and the ''Password''. These informations will allow to your new user to connect him to the server.
+#:[[File:images/CDO_Papyrus_User_Creation2.png|frame|none|]]
+
+
+''Note'':
+*The user is not yet able to change its own password.
+*The user can only edit elements in its own folder.
+*The user can't work on the same model with his colleagues. To do that, the CDO Server administrator must create a new folder and give the access to the users wanting work together.
+
+=How to close properly the CDO Server=
+#Select your repository '''PapyrusCDOSecuredRepository''' in the '''CDO Repository''', then '''Right-Click'''->'''Disconnect'''.
+#:[[File:images/CDO_Server_Disconnect.png|frame|none|]]
+#In the OSGI terminal, type '''close''', then '''y''' (for yes) and the server will shutdown.
+#:[[File:images/CDO_CloseServer.png|frame|none|]]
+
+
+
