Re: [DOC] Example asciidoc file as guideline

2018-09-14 Thread Vaibhav Jain
Hi Michael, +1 Vaibhav Jain Sr. Enterprise Software Engineer HotWax Systems m: 782-834-1900 e: vaibhav.j...@hotwaxsystems.com On Sun, Mar 18, 2018 at 10:26 PM Michael Brohl wrote: > Maybe I was not clear enough... I am suggesting some kind of style guide. > > I think if we provide it in the

Re: [DOC] Example asciidoc file as guideline

2018-09-13 Thread Jacques Le Roux
Thanks Michael and Sharan. Thank you also Taher for the files structure. This is quite useful, I'll follow the way (by shamelessly copying on humanres doc) Jacques Le 19/03/2018 à 09:17, Sharan Foga a écrit : Hi Michael +1 A style guide is a great idea. I've started trying to capture

Re: [DOC] Example asciidoc file as guideline

2018-03-19 Thread Sharan Foga
Hi Michael +1 A style guide is a great idea. I've started trying to capture some general stuff on the documentation wiki page about formatting etc, but it's not enough and needs work so an example document with all the styles we want to use would be good. Thanks Sharan On 2018/03/18

Re: [DOC] Example asciidoc file as guideline

2018-03-18 Thread Taher Alkhateeb
Ahh I see, sounds cool. Looking forward On Sun, Mar 18, 2018 at 7:55 PM, Michael Brohl wrote: > Maybe I was not clear enough... I am suggesting some kind of style guide. > > I think if we provide it in the early stage, people might get inspired from > it and have

Re: [DOC] Example asciidoc file as guideline

2018-03-18 Thread Michael Brohl
Maybe I was not clear enough... I am suggesting some kind of style guide. I think if we provide it in the early stage, people might get inspired from it and have examples in a very compressed form. I find the several examples that I've studied very helpful but they are cluttered all over the

Re: [DOC] Example asciidoc file as guideline

2018-03-18 Thread Taher Alkhateeb
Hmmm, Sounds like a good idea, but perhaps maybe a bit early? We might be still evolving and learning how to structure our documents. Also, maybe if we keep our documents clean and consistent, then they themselves offer an example for how to write stuff? Examples usually run out of date quickly

[DOC] Example asciidoc file as guideline

2018-03-18 Thread Michael Brohl
Heyho, I played around with asciidoc a bit and did some minor changes to display a nice title page and did some configurations for the user/developer manuals. I studied a few example .adoc files and wonder if we should provide a best practice example .adoc file. This could contain all