Hello Steve,
Nice to hear about your proposal.
Just a few comments about docs :
As I said I think that the command line doc is not so bad, for example.
I think that some docs will benefit from a wiki, other docs...not.
For API docs I really think that it must come from the code, as in java API.
What is missing presently in openssl API doc is "function available
since :", "this page has been updated on "date"".
And maybe, as in linux man pages, "maintained by ..." with a valid mail
contact if some errors has to be reported in the doc.
Many people are lacking "HOW TO" docs, which are more suitable for a wiki.
For myself I was looking for command line use cases such as "how to
create a CSR", "how to self sign a cert?",
I want a cert for specific purposes "signing mail/ signing java
applets..." how to do that., how to revoke a cert,
how to check the validity of a cert or a collection of certs in a ca (to
know what to renew), how to renew a cert...
How to set up a quick ca (I checked the code of some apps and scripts
and was not satisfied with the options offered").
And for such an "infinite" set of question and answers, a wiki can be a
good tool.
But with a minimum of structuration in big chapters.
For a programmer, the mailing list can help to find some returning
topics that could be put in a wiki.:
with some programming examples.
What I mean is that I think the API and APPS can only be documented by
the dev team, for their man pages.
But the wiki could deal with specific use cases, HOWTO...and programming
examples.
Best regards,
Pierre
Le 04/02/2013 12:16, Steve Marquess a écrit :
On 02/02/2013 03:46 AM, Bry8 Star wrote:
It would be great to see a wiki site of OpenSSL, like:
https://wiki.openssl.org/
Then helpful, experienced and knowledgeable users can contribute
and help each-others.
This is a good idea that has been proposed a number of times. It hasn't
been acted on before due to limited spare cycles and competition for
other needs like the server move and upgrade. Personally I also have
some reservations, 1) I've never set up or managed a wiki before and
2) the presence of content officially hosted at wiki.openssl.org would
imply endorsement by the OpenSSL team. Frankly there is some very
misleading OpenSSL related documentation and commentary floating
around the Internet, and the only thing worse than no documentation is
bad documentation. I know my colleagues and I may not be able to give
the wiki the attention it needs to always be completely current and
accurate.
But, that shouldn't be an excuse for doing nothing. So I propose to set
up a wiki at the OSF web site, http://wiki.opensslfoundation.com/ as an
initial attempt and experiment. If that turns out well we'll move it to
wiki.openssl.org later.
Based on some preliminary research and input we're looking at
MediaWiki. Give us a few days to get that stood up and I'll make an
announcement when we think it's more or less ready.
-Steve M.
______________________________________________________________________
OpenSSL Project http://www.openssl.org
User Support Mailing List openssl-users@openssl.org
Automated List Manager majord...@openssl.org
