[opencms-dev] OpenCms 9.5.0 documentation

Mon Nov 10 15:20:04 CET 2014

Hi all,

I want to share some points regarding the wiki and the documentation:

We (Alkacon) operate the wiki. In the sense that we run the server and own the domain. This is so since about 2009.

About 2 years ago we started to put more effort in the documentation. The wiki soon proved to be not ideal because of versioning and other issues. 

This is why we did the documentation of 8.5 / 9.0 as PDF and shipped this together with the distribution. 

Our team did not contribute much more to the wiki after we started with the PDF version because we simply do not have the resources to do both.

With 9.5, we have switched from PDF to HTML because we found out that the PDF version was not ideal either. We also greatly increased the resources put into the documentation in general.

The 9.5 documentation will be online in a dedicated website. RTA is before the end of the year (hopefully by end of November).

The 9.5 documentation covers both end-user and developer perspectives. 

I still believe it’s good to have the wiki and I do not intend to shut it down. We will try to link to the wiki better from the official sites.

Any help in the documentation effort is greatly appreciated. 

Kind Regards,

Alex.

-------------------

Alexander Kandzior

Alkacon Software GmbH  - The OpenCms Experts                 

http://www.alkacon.com - http://www.opencms.org                  

From: opencms-dev-bounces at opencms.org [mailto:opencms-dev-bounces at opencms.org] On Behalf Of Schliemann, Kai
Sent: Monday, November 10, 2014 2:59 PM
To: The OpenCms mailing list
Subject: Re: [opencms-dev] OpenCms 9.5.0 documentation

Hello,

1.       I know about the wiki status. And I agree with you, that the wiki should be supported by the community leader. 

2.       Agreed

3.       Why should other open source communities have the time to contribute and this one not? We should think about it as give and take. What I want to say is: I do not have the time either, but I take the time because I think it is important…

Why should Alkacon come up with a solution? We could do that as well. We all belong to the community. I don’t want them to do all the work. They already do a lot. They just have to be ready to accept ideas and support them as good as they can.

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 13:28
An: The OpenCms mailing list
Betreff: Re: [opencms-dev] OpenCms 9.5.0 documentation

Hi again,

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

As I mentioned, the current wiki is not officially supported. If the records are accurate, it was made available by Jan Meier with no official affiliation (at least, not stated in the wiki) with Alkacon (http://www.opencms-wiki.org/index.php?title=OpenCms_Wiki:About <http://www.opencms-wiki.org/index.php?title=OpenCms_Wiki:About&oldid=1498> &oldid=1498) around the 3 November 2006. The wiki states that it currently belongs to Alkacon Software GmbH, but this doesn't correspond with Alkacon's official statement at the OpenCms Days 2014, where Dr. Daniel Seidel confirmed that the wiki isn't opperated by Alkacon, nor maintained, and even suggested that the Alkacon Team don't participate in the Wiki since a long time (in fact, the last contribution was on the 6th November 2012: http://www.opencms-wiki.org/index.php?title=Special%3AContributions <http://www.opencms-wiki.org/index.php?title=Special%3AContributions&tagFilter=&contribs=user&target=Alkacon&namespace=&year=&month=-1> &tagFilter=&contribs=user&target=Alkacon&namespace=&year=&month=-1).

I do like having a wiki, but I don't feel comfortable contributing and investing time in a page that is not officially supported by Alkacon. I don't like either how wild the page has grown and I dare to doubt about its future sustainability and scalability.

2.       New documentation on GitHub. Possibly more user oriented

I could attend Daniel's talk, and I liked how much thinking they have devoted to the documentation. At the same time, it was clear to me that to maintain through all documentation the high standards that they are aming, they won't be able to quickly react to any pull-request (it is good so). That is, the community still needs a lean contribution model to the documentation.

3.       Mailing list for quick answers

Unfortunatelly, I have the impression that there are very few OpenCms experts within the user community with enough time to contribute in this list. Alkacon Team doesn't look to have enough resources to push this option either.

I'm not saying that everything is lost, neither that any of these options are unacceptable. Just that I wish that Alkacon takes all this into consideration and comes up soon with a solution for supporting the community participation (e.g. officially supporting the wiki, or providing a new community-documentation module with lower standards...).

Just my 2 cents...

Regards,

Alberto Gallardo

---
Diese E-Mail ist frei von Viren und Malware, denn der avast! Antivirus Schutz ist aktiv.
http://www.avast.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://webmail.opencms.org/pipermail/opencms-dev/attachments/20141110/03f4de08/attachment.htm>