[Owasp-leaders] Help with OWASP books project - need a web designer

Timur 'x' Khrotko [owasp] timur at owasp.org
Sat Aug 4 23:20:58 UTC 2018


Dear Sherif, interesting, will look into these too, thanks!)
Timur

On Sun, 5 Aug 2018 at 01:03, Sherif Mansour <sherif.mansour at owasp.org>
wrote:

> Hi Timur,
>
> A standard, maintained md CSS is what the current thinking is, so we are
> in allignment there - I would stress it should be optional for the
> community to use, but will be there if the needed it.
> Looking a bit deeper I fournd the following:
>
>    - http://friendsofepub.github.io/Blitz/
>    - http://bbebooksthailand.com/bb-CSS-boilerplate.html
>
> Thanks again,
> -Sherif
>
> On Sat, Aug 4, 2018 at 11:42 PM, Timur 'x' Khrotko [owasp] <
> timur at owasp.org> wrote:
>
>> Offtopic: especially the use of printed guides is doubtful, so I suggest
>> not to make that a priority format/output -- that's an important frame
>> requirement when you make choices about CSS. My experience is that if you
>> made a pole then most of our colleagues would say guides are useless
>> devices when it comes to help developers in their practices. Noone reads
>> guides, instead they check stackoverflow for guidance. So we have to create
>> one click away guidelines competing with the sof articles.
>>
>> Using Ms doc to create stylesheets you mean!? Any and all word processors
>> create horrible HTML and CSS.
>>
>> What I suggested aims to use clean, maintainable and reusable (for
>> different media) CSS. So that I suggested to use a combo: take a standard,
>> maintained md CSS, add your own look on top of it.
>>
>> If OWASP had a professionally designed standard document template I could
>> make you a CSS with that look. Have we? (Or the document design case is
>> like with the new site design, a doomed goal ))
>>
>> Timur
>>
>> On Sun, 5 Aug 2018 at 00:15, Sherif Mansour <sherif.mansour at owasp.org>
>> wrote:
>>
>>> Thanks Timur,
>>>
>>>    - So far in my research I got a makefile and have been able to
>>>    publish from MD to html/epub/PDF - (PDFs are useful to print physical
>>>    copies of books).
>>>    -
>>>    https://github.com/kerberosmansour/OWASP-Books/tree/master/OWASPBooks/InProgress/SAMM/v1.5
>>>    - this is the example for SAMM - note epub/HTML/PDF artifcats
>>>
>>> so we have a process, but my challenge is on the design side and would
>>> like some help there to produce a template for all OWASP to use (both CSS &
>>> Latex) - I heard some have used MS Doc for style but I am not familiar with
>>> that process.
>>>
>>> -Sherif
>>>
>>>
>>> On Sat, Aug 4, 2018 at 10:40 PM, Timur 'x' Khrotko [owasp] <
>>> timur at owasp.org> wrote:
>>>
>>>> Hello, I work on a document pipeline of a similar sort: to prepare
>>>> collaborative book/guide content in md (hosted on gitlab, or github, or/and
>>>> in local gits), to compile the publications with pandoc and publish it
>>>> online (for me the PDF books are secondary in their practical usefulness).
>>>> We prepare a couple of such collaborative defdev publications: an ssdlc
>>>> playbook and secure coding guides.
>>>>
>>>> I suggest using a standard 'css for md' css as base -- there are a
>>>> number of such csses. You can dig a nice one from the internals of visual
>>>> code for example. Or (as I do) you can start off the
>>>> https://github.com/sindresorhus/github-markdown-css
>>>>
>>>> Then you add your custom css next in the cascade. You need a designer
>>>> for the latter only.
>>>>
>>>> Also in case of a book your source is not a monolithic md but pieces
>>>> which you have to concatenate before feeding to pandoc. And you can hit a
>>>> couple of the md weaknesses, like line breaks which working your editors
>>>> are not expected to learn.
>>>>
>>>> Let me know if I can help with some particular issues.
>>>>
>>>> Timur
>>>>
>>>>
>>>> On Sat, 4 Aug 2018 at 15:14, Sherif Mansour <sherif.mansour at owasp.org>
>>>> wrote:
>>>>
>>>>> Hey Gang
>>>>>
>>>>> Now that AppsecEU is behind us, I need some small web design help on
>>>>> the owasp books project, if you know a web desinger or would like to help
>>>>> it would be much appreciated.
>>>>>
>>>>> The idea is to provide the various OWASP document projects with a
>>>>> template and a service to publish their documents in various formats - when
>>>>> they so choose.
>>>>>
>>>>> Basically OWASP has a lot of books in various formats. We want
>>>>> provide a service to document projects to move them to MarkDown format and
>>>>> from there we can use a tool called pandocs to export them to any format
>>>>> (PDF/Ebooks/physical books etc..). That way we can update them easily and
>>>>> publish them on amazon etc..
>>>>>
>>>>> We have already helped the SAMM project convert their PDF of version
>>>>> 1.5 into Mark Down. We need to produce a nice design template (CSS) for
>>>>> projects to use if they want.
>>>>>
>>>>>
>>>>> *Where are the books?*
>>>>> Currently we have one book: The SAMM ebook can be found here (this
>>>>> includes the images, and mobi/epub formats):
>>>>> https://github.com/OWASP/samm/tree/master/v1.5/MarkDown
>>>>>
>>>>> The basic instructions on how to convert a md file to an ebook can be
>>>>> found here:
>>>>> https://github.com/OWASP/samm/blob/master/v1.5/MarkDown/Owasp-Books.md
>>>>>
>>>>> However it doesn't look great. Now pandocs has actually a template to
>>>>> show how it's done properly here:
>>>>> https://github.com/wikiti/pandoc-book-template
>>>>>
>>>>>
>>>>> *What is the ask:*
>>>>>
>>>>>    - Take the contents of the current MD formated book (see link
>>>>>    <https://github.com/OWASP/samm/tree/master/v1.5/MarkDown>).
>>>>>    - Go through the pandoc guide here:
>>>>>    https://github.com/wikiti/pandoc-book-template
>>>>>    <https://github.com/wikiti/pandoc-book-template>
>>>>>    - Format the book to look "cleaner" and ready for publishing (the
>>>>>    book can take a CSS as well like in the guide above).
>>>>>
>>>>> *What is the plan next?*
>>>>> Please reach out to me, we have many documents and we want to ensure
>>>>> they are updated regularly so a default book design/format would help
>>>>> the foundation greatly.
>>>>>
>>>>>
>>>>> --
>>>>>
>>>>> Sherif Mansour
>>>>> OWASP Global Board Member & OWASP London Chapter Leader
>>>>> Site: https://www.owasp.org/index.php/London
>>>>> Email: sherif.mansour at owasp.org
>>>>> Follow OWASP London Chapter on Twitter: @owasplondon  <https://twitter.com/OWASPLondon>
>>>>> "Like" us on Facebook: https://www.facebook.com/OWASPLondon
>>>>> Subscribe to our (lightweight) mailing list: https://lists.owasp.org/mailman/listinfo/owasp-london
>>>>>
>>>>> Consider giving back, and supporting the open source community by
>>>>> becoming a member <https://www.owasp.org/index.php/Membership> or
>>>>> making a donation <https://www.owasp.org/index.php/Donate> today!
>>>>>
>>>>>
>>>>> Join us at AppSec USA 2018 <https://2018.appsecusa.org/> 8-12 October
>>>>> in San Jose, CA!
>>>>>
>>>>> This message may contain confidential information - you should handle
>>>>> it accordingly.
>>>>> _______________________________________________
>>>>> OWASP-Leaders mailing list
>>>>> OWASP-Leaders at lists.owasp.org
>>>>> https://lists.owasp.org/mailman/listinfo/owasp-leaders
>>>>>
>>>> --
>>>>
>>>> secmachine․net #wepowersecdev
>>>>
>>>
>>>
>>>
>>> --
>>>
>>> Sherif Mansour
>>> OWASP Global Board Member & OWASP London Chapter Leader
>>> Site: https://www.owasp.org/index.php/London
>>> Email: sherif.mansour at owasp.org
>>> Follow OWASP London Chapter on Twitter: @owasplondon  <https://twitter.com/OWASPLondon>
>>> "Like" us on Facebook: https://www.facebook.com/OWASPLondon
>>> Subscribe to our (lightweight) mailing list: https://lists.owasp.org/mailman/listinfo/owasp-london
>>>
>>> Consider giving back, and supporting the open source community by
>>> becoming a member <https://www.owasp.org/index.php/Membership> or
>>> making a donation <https://www.owasp.org/index.php/Donate> today!
>>>
>>>
>>> Join us at AppSec USA 2018 <https://2018.appsecusa.org/> 8-12 October
>>> in San Jose, CA!
>>>
>>> This message may contain confidential information - you should handle it
>>> accordingly.
>>>
>> --
>>
>> secmachine․net #wepowersecdev
>>
>
>
>
> --
>
> Sherif Mansour
> OWASP Global Board Member & OWASP London Chapter Leader
> Site: https://www.owasp.org/index.php/London
> Email: sherif.mansour at owasp.org
> Follow OWASP London Chapter on Twitter: @owasplondon  <https://twitter.com/OWASPLondon>
> "Like" us on Facebook: https://www.facebook.com/OWASPLondon
> Subscribe to our (lightweight) mailing list: https://lists.owasp.org/mailman/listinfo/owasp-london
>
> Consider giving back, and supporting the open source community by becoming
> a member <https://www.owasp.org/index.php/Membership> or making a donation
> <https://www.owasp.org/index.php/Donate> today!
>
>
> Join us at AppSec USA 2018 <https://2018.appsecusa.org/> 8-12 October in
> San Jose, CA!
>
> This message may contain confidential information - you should handle it
> accordingly.
>
-- 

secmachine․net #wepowersecdev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.owasp.org/pipermail/owasp-leaders/attachments/20180805/71afbc3a/attachment-0001.html>


More information about the OWASP-Leaders mailing list