[Xerte-dev] Re: Documentation process

[Mark Berthelemy]

Yep. It's berthelemy.

Mark  

--  
Mark Berthelemy
Managing Director
Tel: 01773 318 962
Mob: 07922 146 761
Web: www.wyversolutions.co.uk

Wyver Solutions Ltd | Company number: 5731173 Registered in England | Registered address: First Floor, 6 Bridge Street, Belper, Derbyshire, DE56 1AX


On Thursday, 21 November 2013 at 16:00, Julian Tenney wrote:

> Do you have a github username? I’ll add you as a collaborator.
>   
> From: xerte-dev-bounces at lists.nottingham.ac.uk [mailto:xerte-dev-bounces at lists.nottingham.ac.uk] On Behalf Of Mark Berthelemy
> Sent: 21 November 2013 15:53
> To: For developers
> Subject: [Xerte-dev] Documentation process
>   
> Hi all,  
>  
>   
>  
> Rather than setting up a separate wiki for documentation, I'd like to investigate using a sub-repository on Github which is then incorporated into the main Xerte codebase as /docs.
>  
>   
>  
> The sub-repository would use the Github wiki as its source, so can easily be edited online.
>  
>   
>  
> The files are in markdown format, so I'll look at adding markdown support via a PHP markdown interpreter, so they can be viewed locally.
>  
>   
>  
> This approach would allow us to make sure that each release of XOT has a valid, version-controlled set of documentation attached to it.
>  
>   
>  
> Useful references:
>  
>   
>  
> http://brendancleary.com/2013/03/08/including-a-github-wiki-in-a-repository-as-a-submodule/
>  
>   
>  
> Can anyone suggest a reason for not going down this route?
>  
>   
>  
> Mark
>  
>   
>  
> --  
>  
> Mark Berthelemy
>  
> Managing Director
>  
> Tel:      01773 318 962
>  
> Mob:    07922 146 761
>  
> Web:    www.wyversolutions.co.uk (http://www.wyversolutions.co.uk)
>  
>   
>  
> Wyver Solutions Ltd | Company number: 5731173 Registered in England | Registered address: First Floor, 6 Bridge Street, Belper, Derbyshire, DE56 1AX
>  
>   
>  
>  
>  
>  
> _______________________________________________
> Xerte-dev mailing list
> Xerte-dev at lists.nottingham.ac.uk (mailto:Xerte-dev at lists.nottingham.ac.uk)
> http://lists.nottingham.ac.uk/mailman/listinfo/xerte-dev
>  
>  


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.nottingham.ac.uk/pipermail/xerte-dev/attachments/20131121/92610e2b/attachment-0001.html>