notion-general

[Notion-general] Notion site and documentation

[Arnout E. <ar...@bz...>]

Hi all,

The Notion site and documentation is currently kind of old-fashioned and
fragmented:

* Some static HTML pages on sf.net
* Some HTML/PDF documentation generated from latex sources
* A sf.net wiki that was discontinued (I have tar.gz and sql.gz backups,
but haven't looked into them yet)

We're long overdue for a switch to a more modern setup.

I'd like to move everything to jekyll/github-pages. As a crude first step I
moved over the 'tour' to http://raboof.github.io/notion/tour/ which is
generated from https://github.com/raboof/notion/blob/gh-pages/tour.md

I would warmly appreciate any help with:
* Creating a more modern theme
* Creating a project frontpage (or migrating the existing one?)
* Migrating the latex docs to github pages
* Migrating the mediawiki content to github pages
* Improving our documentation overall
* Improving the presentation of our documentation overall (revisiting the
tour it still seems like a very good introduction, but could be presented
in a more friendly way)
* Any ideas, feedback, tips, etc!


Kind regards,

Arnout

Re: [Notion-general] Notion site and documentation

[Jeff B. <jef...@gm...>]

On Thu, Jul 10, 2014 at 11:15:25PM +0200, Arnout Engelen wrote:
>I would warmly appreciate any help with:
(..snip..)
>* Migrating the latex docs to github pages

Hi Arnout,

I can help poke at the LaTeX -> Github pages. Perhaps afterward we can 
chuck the LaTeX docs? I haven't played with Github pages too much, so 
I'll need someone to point me in the right direction. :)

Regards,
Jeff

Re: [Notion-general] Notion site and documentation

[Arnout E. <ar...@bz...>]

On Sun, Jul 13, 2014 at 12:00 AM, Jeff Backus <jef...@gm...> wrote:

> On Thu, Jul 10, 2014 at 11:15:25PM +0200, Arnout Engelen wrote:
>
>> I would warmly appreciate any help with:
>>
> (..snip..)
>
>  * Migrating the latex docs to github pages
>>
>
> Hi Arnout,
>
> I can help poke at the LaTeX -> Github pages.


Cool!


> Perhaps afterward we can chuck the LaTeX docs?


Yes, that's the idea. LaTeX has served us well in the past, but it seems
like it's time to move on. Using markdown and github-pages seems like a
nice contributor-friendly workflow (though we'll still have to find a way
to generate the API documentation and merge those).


> I haven't played with Github pages too much, so I'll need someone to point
> me in the right direction. :)
>

I'm new to it, too. 'pandoc' seemed like a nice tool to convert latex files
to markdown files. For the tables of contents, it seems 'kramdown', the
markdown-to-html converter for github-pages, has some support for that.
Beyond that, it's time to explore :).


Kind regards,

Arnout

Re: [Notion-general] Notion site and documentation

[Jeff B. <jef...@gm...>]

On Sun, Jul 13, 2014 at 6:17 AM, Arnout Engelen <ar...@bz...> wrote:

>
>
>> Perhaps afterward we can chuck the LaTeX docs?
>
>
> Yes, that's the idea. LaTeX has served us well in the past, but it seems
> like it's time to move on. Using markdown and github-pages seems like a
> nice contributor-friendly workflow (though we'll still have to find a way
> to generate the API documentation and merge those).
>
>
Sounds good!

I haven't played with Github pages too much, so I'll need someone to point
>> me in the right direction. :)
>>
>
> I'm new to it, too. 'pandoc' seemed like a nice tool to convert latex
> files to markdown files. For the tables of contents, it seems 'kramdown',
> the markdown-to-html converter for github-pages, has some support for that.
> Beyond that, it's time to explore :).
>
>
> There is also LaTeXML <http://dlmf.nist.gov/LaTeXML/> which may be
useful. I'll get to digging. :)

Regards,
Jeff
-- 
Jeff Backus
jef...@gm...
http://github.com/jsbackus

Re: [Notion-general] Notion site and documentation

[Wojciech A. <ani...@co...>]

Hi
> I would warmly appreciate any help with:
> * Creating a more modern theme
what does 'modern' mean? example?
sites like awesomes' are extremely zen:)
w

> * Creating a project frontpage (or migrating the existing one?)
> * Migrating the latex docs to github pages
> * Migrating the mediawiki content to github pages
> * Improving our documentation overall
> * Improving the presentation of our documentation overall (revisiting the
> tour it still seems like a very good introduction, but could be presented
> in a more friendly way)
> * Any ideas, feedback, tips, etc!
> 
> 
> Kind regards,
> 
> Arnout

> ------------------------------------------------------------------------------
> Open source business process management suite built on Java and Eclipse
> Turn processes into business applications with Bonita BPM Community Edition
> Quickly connect people, data, and systems into organized workflows
> Winner of BOSSIE, CODIE, OW2 and Gartner awards
> http://p.sf.net/sfu/Bonitasoft

> _______________________________________________
> Notion-general mailing list
> Not...@li...
> https://lists.sourceforge.net/lists/listinfo/notion-general


-- 
Wojtek Aniszewski
[Eng: voyteck aanishevsky]
[Fr:  vôytek anichévsky]

 /^..^\      ,-------------------------------------,
( (••) ) ----| My public GPG key ID: AC66485E      |
(|)_._(|)~   | please use email encryption!        |
             `-------------------------------------"

Re: [Notion-general] Notion site and documentation

[Arnout E. <ar...@bz...>]

On Thu, Jul 17, 2014 at 7:05 PM, Wojciech Aniszewski <ani...@co...>
wrote:

> > I would warmly appreciate any help with:
> > * Creating a more modern theme
> what does 'modern' mean? example?
> sites like awesomes' are extremely zen:)
>

Oh yeah, that (http://awesome.naquadah.org/) looks pretty great! Doesn't
have to be fancy :).



Kind regards,

Arnout