[opencms-dev] OpenCms 9.5.0 documentation

[Schliemann, Kai]

Hi Alberto, hi list,
I am totally with you, that the documentation for OpenCms needs to get better, even, when compared to other OS software, it is not that bad.
We talked about that in the partner meeting during the OpenCms Days. We actually didn’t find a final agreement. One recommendation was, to at least place some prominent links to documentation pages like the opencms-wiki.org page.

Concerning the new documentation, there was a session from Daniel Seidel about that, which I unfortunately could participate. But I learned, that it is in HTML format, similar to the documentation modules shipped with OpenCms. I also heard, that this documentation should be placed on GitHub. So if somebody changes or adds something to the documentation, he / she could send a pull request to Alkacon.

So in my opinion, we will have more options for documentation in the future.

1.       Wiki for short howtos and FAQs. Possibly more developer oriented

2.       New documentation on GitHub. Possibly more user oriented

3.       Mailing list for quick answers

Personally I would like to motivate the mailing lists members to contribute to the documentation.
For example, when you found a solution for a problem, you solved with the help of the mailing list, to take a few minutes and add the solution to the opencms-wiki.org.
In this way we could really get a good resource for checking out, whenever we have a problem with OpenCms.

Best regards
Kai



Von: opencms-dev-bounces at opencms.org [mailto:opencms-dev-bounces at opencms.org] Im Auftrag von Alberto Gallardo
Gesendet: Montag, 10. November 2014 11:23
An: The OpenCms mailing list
Betreff: [opencms-dev] OpenCms 9.5.0 documentation

Dear list,

as per Alkacon's request, I'm rising the question about what are the plans to allow the community to contribute with current documentation.

I learnt in the OpenCms Days 2014 that the opencms-wiki is not officially supported. It was a great option though for quickly documenting opencms without administrative or formal burdens. It'd be great if Alkacon were to provide an alternative to it.
By the way, kudos to the improvement of the old documentation chaos. The new documentation concept, revamped content and structure looks very promising.
Regards,

Alberto Gallardo
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://webmail.opencms.org/pipermail/opencms-dev/attachments/20141110/b938b5e8/attachment.htm>