Dear Steve,
I was wondering whether the wiki could be "fed" at the beginning by all
the Documents available at "http://www.openssl.org/docs/";.
Very often people are able to comment, eg, a command page with some
samples or error comments,
instead of rewriting from scratch a "man page".
And this could be a way to only have one unique set of docs to maintain,
and to refer to, instead of having two...
Personnally I think the present doc is not so bad, but, as it seems from
the mailing list,
sometime some command or api call miss a clarification or a sample.
Moreover, for the lib, I suggest to separate the "reference manual",
describing and commenting each api call,
from a kind of "programmers' manual", that could describe how to use the
lib for various purposes:
such manuals were available for various programming tools in the past,
and I have always been happy with those 2 complementary set of docs.
For the command line set, and general config/install of the tool I
suggest to do the same :
- reference doc of each command and conf file
- advanced users' manual covering install/config/and usage for various
purposes.
For example : I am using the command line tools as a very basic pki
system to create certificate for my company. Those certs are produced by
openssl to be used by openssl based applications such as stunnel or
Apache: those usage are very common and should be documented in an
advanced users manual.
Sometime those certs have to be imported in client apps such as Mozilla
Firefox or Thunderbird, or M$ Ie and outllook :
I think the wiki/adv users manual could be a good repository for all this.
And of course, although openssl is for advanced users, I think some
pedagogic material on cryptography and its usage, and the benefit of
using openssl to fulfill those needs,
could be very useful.
Well, in fact I am wondering about the best way to structure the
chapters of the wiki : depending on that, we can hope to have something
as clear and useful as possible, instead of being a bazaar of various
things.
Personnally I can contribute to some command line tools usage case,
although I have to admit that I feel a little bit intimidated to publish
something on this prestigious wiki...
although I was wishing it myself...
Yours sincerely,
Pierre
Le 19/03/2013 13:51, Steve Marquess a écrit :
With some trepidation, and considerable assistance from a small group of
earlier adopters, I hereby unleash a new OpenSSL Wiki on an unsuspecting
world:
http://wiki.opensslfoundation.com/
There is a need for more and better OpenSSL documentation, and the
hopeful theory here is that this Wiki will serve as a focal point for
collecting useful content that over time will converge into a useful and
comprehensive resource.
Since I and some of the initial collaborators are still learning about
Wiki management it will remain on a separate server and the
opensslfoundation.com domain for an indeterminate trial period. If it
evolves into a useful resource, and once we're comfortable with all the
security and technical implications, then we will migrate it to a
wiki.openssl.org domain. We're still in the process of migrating the
legacy openssl.org server to a new home and this Wiki is another
complication we don't need right now.
There is some content already but new contributions are welcome. We'll
be wanting to add some more administrators ("sysops") too.
-Steve M.
______________________________________________________________________
OpenSSL Project http://www.openssl.org
Development Mailing List openssl-dev@openssl.org
Automated List Manager majord...@openssl.org
