[Date Prev][Date Next] [Chronological] [Thread] [Top]

Re: Documentation

Daniel Howard wrote:

My recent experience is OpenLDAP on Ubuntu. I thought I would go with
OpenLDAP's guide because they should know better, but the quick start was for
older versions or something and hadn't been updated.

I like documentation systems that allow for user feedback, comments, or
patches via github.
Sorry, that will never happen. We use git, and we use github, but we will never rely on github. It is too much of a SPOF in the open source ecosystem and far too juicy an attack target. 


If you want community improvements then maybe low hanging
fruit is a link in the doc template on how to interact with the
documentation.... If the current docs platform has no mechanism for feedback
and comments on a specific document, the source code/ build process is obscure
... Maybe consider porting even a "fork " to github and solicit community
feedback (you can file issues in a familiar mechanism, and take in patches
from dudes like me...)



For what it's worth, the Ubuntu OpenLDAP quick start guide and only a few
minor hiccups, and I would recommend that resource for anyone looking to
implement or update a quickstart guide.

The Faq-o-Matic ... Man a modern stack overflow site might be nice but a
question in the back of my mind is whether the advice is still useful. I don't
know if the FoM does this but if the answers showed dates


Of course it can.


then I could
evaluate an answer that's say 2-4 years old with greater confidence than say
something 12 years old ...
I agree with you there. But I already have dates/attributions enabled in my FoM profile. 


One of the challenges of a venerable, old and
mature project like OpenLDAP.
No, one of the challenges of a modern population that doesn't take the effort to read. Frankly, that population is a waste of time. 


I guess what I'm trying to say, from my mobile phone, is if the documentation
were more "agile" in engaging the community for identifying issues and taking
in corrections, we may all be happier.
The process of creating a patch with git is the same, whether we use github or not. I don't believe that's particularly meaningful. 


I would be open to volunteering to port docs...

Thanks,
-Danny

--
Sent from my Western Electric Model 500

On Apr 29, 2016 5:01 PM, "Gavin Henry" <ghenry@openldap.org
<mailto:ghenry@openldap.org>> wrote:

    Hi all,

    List what you love about our docs:

    List what you hate:

    List what you'd love to see:

    List what you can help with:

    Thanks.

    --
    Kind Regards,
    Gavin Henry.




--
  -- Howard Chu
  CTO, Symas Corp.           http://www.symas.com
  Director, Highland Sun     http://highlandsun.com/hyc/
  Chief Architect, OpenLDAP  http://www.openldap.org/project/