Projects tigase _server server-core Issues #749
Missing documentation about DSL configuration (#749)
Artur Hefczyc opened 8 years ago
Due Date
2017-01-31

There is no explanation or documentation about DSL configuration file format which is used by the most recent Tigase XMPP Server. I am not sure if the documentation is not yet written or just the documentation on the website is not up to date: http://docs.tigase.org/#collapse-tigase-server-snapshot-head

wojciech.kapcia@tigase.net commented 8 years ago

Artur Hefczyc wrote:

There is no explanation or documentation about DSL configuration file format which is used by the most recent Tigase XMPP Server. I am not sure if the documentation is not yet written or just the documentation on the website is not up to date: http://docs.tigase.org/#collapse-tigase-server-snapshot-head

It's written and verified (vide #4481) and as explained in #3633 it wasn't build daily - it was possible to build it manually/locally from master branch. After completing #3633 and running jenkins build it's available on @docs.tigase.org@: http://docs.tigase.org/tigase-server/snapshot/User_Guide/html_chunk/configuration.html#dslConfig

Artur Hefczyc commented 8 years ago

Ok, I can see the DSL file description now. I have a few questions about the documentation and the DSL configuration file:

  1. We used to have 5 separate documents for the Tigase XMPP Server: properties, admin, user, devel, javadoc. For the snapshot version I can only see User Guide. While I think it is a good move to consolidate admin, user and properties, I think that development guide should be still there as a separate document. Also, instead of User Guide I think it should be called Administration Guide.

  2. From the current document it is not clear to me whether we can still use the old properties file with version 7.2.0 or dsl format only. Also, in the example DSL file there are some '--property=value' lines, so the question, can we still use the old properties in the new DSL file? How to convert or migrate from the old properties file to the new DSL format? Do we have any tools or a graceful way to migrate?

wojciech.kapcia@tigase.net commented 8 years ago

Artur Hefczyc wrote:

Ok, I can see the DSL file description now. I have a few questions about the documentation and the DSL configuration file:

We used to have 5 separate documents for the Tigase XMPP Server: properties, admin, user, devel, javadoc. For the snapshot version I can only see User Guide. While I think it is a good move to consolidate admin, user and properties, I think that development guide should be still there as a separate document.

In was condensed into one guide to solve inter-document linking issue which surfaced when we migrated from drupal to asciidoc. It also automatically import per-component guides so in the distribution package user has complete guide and we can maintain particular component guide in it's own repository.

We can separate Development Guide but we will loose linking capabilities.

Also, instead of User Guide I think it should be called Administration Guide.

If we maintain single document we could call it Tigase Guide, if not then Administration Guide and Development Guide seems reasonable. (related #4879)

From the current document it is not clear to me whether we can still use the old properties file with version 7.2.0 or dsl format only. Also, in the example DSL file there are some '--property=value' lines, so the question, can we still use the old properties in the new DSL file? How to convert or migrate from the old properties file to the new DSL format? Do we have any tools or a graceful way to migrate?

Only new format - and if you start new version with the old properties file then it will be converted to new format (this may still have some issues, majority of the most common configuration should be handled OK though) and the backup will be made.

as for the --properties it's explained in the guide:

h3. Setting global property

Like in properties file it is still possible to use property names starting with -- without any context or any other properties at global scope. Format is the same as in case of setting property but they are defined without scope (in global scope). This properties are global and accessible by any bean but also set as system property in JVM.

Artur Hefczyc commented 8 years ago

Wojciech Kapcia wrote:

Artur Hefczyc wrote:

Ok, I can see the DSL file description now. I have a few questions about the documentation and the DSL configuration file:

We used to have 5 separate documents for the Tigase XMPP Server: properties, admin, user, devel, javadoc. For the snapshot version I can only see User Guide. While I think it is a good move to consolidate admin, user and properties, I think that development guide should be still there as a separate document.

In was condensed into one guide to solve inter-document linking issue which surfaced when we migrated from drupal to asciidoc. It also automatically import per-component guides so in the distribution package user has complete guide and we can maintain particular component guide in it's own repository.

We can separate Development Guide but we will loose linking capabilities.

Hm, OK understand now, let's leave it as it is now.

Also, instead of User Guide I think it should be called Administration Guide.

If we maintain single document we could call it Tigase Guide, if not then Administration Guide and Development Guide seems reasonable. (related #4879)

In such a case, maybe: Server Documentation

From the current document it is not clear to me whether we can still use the old properties file with version 7.2.0 or dsl format only. Also, in the example DSL file there are some '--property=value' lines, so the question, can we still use the old properties in the new DSL file? How to convert or migrate from the old properties file to the new DSL format? Do we have any tools or a graceful way to migrate?

Only new format - and if you start new version with the old properties file then it will be converted to new format (this may still have some issues, majority of the most common configuration should be handled OK though) and the backup will be made.

Ok.

as for the --properties it's explained in the guide:

h3. Setting global property

Like in properties file it is still possible to use property names starting with -- without any context or any other properties at global scope. Format is the same as in case of setting property but they are defined without scope (in global scope). This properties are global and accessible by any bean but also set as system property in JVM.

Ok

issue 1 of 1
Type
Task
Priority
Major
Assignee
RedmineID
4865
Version
tigase-server-8.0.0
Spent time
5h
Issue Votes (0)
Watchers (0)
Reference
tigase/_server/server-core#749
Please wait...
Page is in error, reload to recover