[ 
https://issues.apache.org/jira/browse/OPENMEETINGS-447?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

SebastianWagner updated OPENMEETINGS-447:
-----------------------------------------

    Description: 
In order to asure our Backups are still valid in future version we need some 
kind of documentation.

It might be possible to generate the documentation from the Java Classes, 
similar to the SOAP/REST API.

It will be important to note in the documentation which attribute is available 
since what backup/openmeetings version.

However it needs also some general information about the layout of the ZIP file 
and where the other files like uploaded documents, recordings, profile images 
and recordings are stored in the ZIP.

The docs should also indicate how to correctly add new attributes and mark them 
with the @Version tag to make the Import/Export backwards compatible:
http://simple.sourceforge.net/download/stream/doc/tutorial/tutorial.php#version

  was:
In order to asure our Backups are still valid in future version we need some 
kind of documentation.

It might be possible to generate the documentation from the Java Classes, 
similar to the SOAP/REST API.

It will be important to note in the documentation which attribute is available 
since what backup/openmeetings version.

However it needs also some general information about the layout of the ZIP file 
and where the other files like uploaded documents, recordings, profile images 
and recordings are stored in the ZIP.

    
> Create Documentation about exact Backup file format and content (including 
> XML elements and attributes)
> -------------------------------------------------------------------------------------------------------
>
>                 Key: OPENMEETINGS-447
>                 URL: https://issues.apache.org/jira/browse/OPENMEETINGS-447
>             Project: Openmeetings
>          Issue Type: Bug
>            Reporter: SebastianWagner
>              Labels: Backup, Documentation
>
> In order to asure our Backups are still valid in future version we need some 
> kind of documentation.
> It might be possible to generate the documentation from the Java Classes, 
> similar to the SOAP/REST API.
> It will be important to note in the documentation which attribute is 
> available since what backup/openmeetings version.
> However it needs also some general information about the layout of the ZIP 
> file and where the other files like uploaded documents, recordings, profile 
> images and recordings are stored in the ZIP.
> The docs should also indicate how to correctly add new attributes and mark 
> them with the @Version tag to make the Import/Export backwards compatible:
> http://simple.sourceforge.net/download/stream/doc/tutorial/tutorial.php#version

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Reply via email to