[Owasp-leaders] Sharing experience of yet another way to publish documentation projects

psiinon psiinon at gmail.com
Mon Feb 18 09:39:08 UTC 2019


Thanks for sharing this Taras, thats really useful!

On Sun, Feb 17, 2019 at 7:48 PM Taras Ivaschenko <taras.ivaschenko at owasp.org>
wrote:

> Hello,
>
> I see that last time some OWASP documentation projects migrated to
> GitHub and text based formats plus various technologies to publish it.
>
> In this letter I want just share yet another way to do it :) May be it
> could be helpful for someone (like
> https://www.owasp.org/index.php/OWASP_AppSec_Pipeline).
>
> For Russian translation of OWASP Proactive Controls we used:
> * GitHub for repository
> (https://github.com/owasp-russia/top-10-proactive-controls)
> * Sphinx (http://www.sphinx-doc.org) as documentation generator which
> gives us various output format and l10n support out of box
> * reStructuredText (https://en.wikipedia.org/wiki/ReStructuredText) as
> base text format. It is similar to Markdown but much more powerful
> * Popular documentation service called "Read The Docs"
> (https://readthedocs.org/) as publishing platform and CI/CD service. So
> we get free web hosting for result docs, multilanguage support,
> auto-generated PDF, EPUB and HTML versions and other cool features. It
> also has support for custom domain, so if we want we could have e.g.
> https://docs.owasp.org/projects/foobar
> * For localization we used special service Transifex
> (https://www.transifex.com/). So translators don't need to fork original
> English version and get easy to use special l10n service.
>
> HTML version is available at
> https://owasp-top-10-proactive-controls-2018.readthedocs.io/en/latest/
>
> Feel free to ask questions.
>
> --
> Taras Ivashchenko
> https://www.owasp.org/index.php/Russia
>
> _______________________________________________
> OWASP-Leaders mailing list
> OWASP-Leaders at lists.owasp.org
> https://lists.owasp.org/mailman/listinfo/owasp-leaders
>


-- 
OWASP ZAP <https://www.owasp.org/index.php/ZAP> Project leader
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.owasp.org/pipermail/owasp-leaders/attachments/20190218/177b6171/attachment.html>


More information about the OWASP-Leaders mailing list