Add better docs / a wiki with community access / comments?

[Simon L]

Hi everyone,

I'm really liking OrientDB, but I'm finding there could be improved detailed documentation. Sometimes I'll get an error code and it's due to some unusual corner case. I'll be stuck.

Could we get more complete documentation on errors (maybe based on JavaDoc) and also maybe use a wiki where we can add comments? That way, we can also have comments about errors and how we solved them.

DokuWiki might be a good solution for this.

Ex:

For:

OrientDB.RequestError: Wrong user/password to [connect] to the remote OrientDB Server instance. Get the user/password from the config/orientdb-server-config.xml file.

It could be a result of how roles are set up for that user. I could make a comment or suggest an edit.

The PHP docs are a good example of this and I think that was a key reason why it because so popular.

[Riccardo Tasso]

+1

I am sure that a community wiki or at least a section for comments would be very appreciated!

Riccardo

--

---
You received this message because you are subscribed to the Google Groups "OrientDB" group.
To unsubscribe from this group and stop receiving emails from it, send an email to orient-databa...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Luca Garulli]

Hi Guys,

We're using GitHub, and AFAIK there is no way to setup comments. I'm exploring Gollum, anybody tried it?

Lvc@

[Simon L]

One option I've used and like is WikiSpaces.com. It's a hosted solution for $5/month. So it's not free but might save time. You can also export the data as HTML. It supports comments and public or protected wikis. It's very easy to use. Tho if you want to use your own domain I think the price goes up to $20/month.

Never tried Gollum. GitHub's wiki is pretty limited compared to what's out there. For my other free open-source project, I used DokuWiki which was both really easy to set up and looks very good. (We have comments disabled tho.) Here's an example:

http://iquploader.com/syncdocs/doku.php

--

---
You received this message because you are subscribed to a topic in the Google Groups "OrientDB" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/orient-database/jc9eZwyzm1U/unsubscribe.
To unsubscribe from this group and all its topics, send an email to orient-databa...@googlegroups.com.