I would applaud the effort to create better (and more tutorial-style) 
documentation.



It would also be great to bring the documentation and examples up to date.



[Description: cid:[email protected]]





-----Original Message-----
From: [email protected] [mailto:[email protected]] On 
Behalf Of [email protected]
Sent: Friday, November 14, 2014 8:03 AM
To: [email protected]; [email protected]
Subject: RE: Improving Developer Documentation





There is a vast quantity of OpenSSL information on the Internet.  There's even 
an O'Reilly book:  
http://www.amazon.co.uk/Network-Security-OpenSSL-Cryptography-Communications/dp/059600270X



This looks like a good one to start with:

http://www.rtfm.com/openssl-examples/part1.pdf



Whether they could all be better linked from the OpenSSL wiki is a different 
question of course :)



Good luck!





> Message Received: Nov 14 2014, 01:58 AM

> From: "Casey Dunham" <[email protected]>

> To: [email protected]

> Cc:

> Subject: Improving Developer Documentation

>

> Greetings,

>

> I have just subscribed and hopefully I am not breaking any list

> etiquette here, but I wanted to respond to the thread that was started

> back in April on Improving the Documentation for OpenSSL.

>

> http://marc.info/?l=openssl-dev&m=139832883828644

>

> I am a developer (BS CS, Minor in Math) but not up to speed with the

> OpenSSL library and more to my immediate interests, the cryptographic

> library that is part of OpenSSL.

>

> I am looking at using it in an upcoming project, but I definitely need

> to learn more about crypto.

>

> However, getting started with OpenSSL from reading the main project

> page at openssl.org and the wiki leaves a bit to be desired. The wiki

> was very useful however as it was the only place I could find usage

> examples ;)

>

> It took me a while to get started with a simple example and just

> getting an overview of the API is not easy (yes the source code which I am 
> using).

>

> I also noticed that some of the code examples need to be updated.

>

> So I think that there are really three different areas of

> documentation that would be useful:

>

> - User documentation for the command line applications

> - Developer documentation for the OpenSSL / Crypto APIs

> - Up to date code examples for the usage of the APIs

>

> Having a single online resource for this would be great (unless I am

> completely missing a resource here).

>

> My main incentive is to provide a resource that developers could use

> to get started with the API quickly while also providing inline best

> practices and good coding examples.

>

> I have sent an email requesting access to the wiki and am interested

> in helping out where I can.

>

> Sorry for the long message!

>

> Regards,

> Casey

>

______________________________________________________________________

OpenSSL Project                                 http://www.openssl.org

Development Mailing List                       
[email protected]<mailto:[email protected]>

Automated List Manager                           
[email protected]<mailto:[email protected]>

<<attachment: Stephen F Bush.vcf>>

Reply via email to