← Back to team overview

kicad-developers team mailing list archive

Re: documentation format

 

On Wednesday, 4 de February de 2015 at 15:06, Wayne Stambaugh wrote:
> - Set up repo on some git hosting sight. I heard some negative feedback
> at FOSDEM about using github since apparently it is not free software so
> I'm open to suggestion on this. If github is the best choice then I'm
> OK using it but it might be worth exploring other git based hosting
> alternatives.
>  
>  

I’m very positive about github, even if it’s not free software, they support
very well lots of open source communities, and in the end it’s just git
with a nice web interface, and a nice API.

If something goes wrong git github is just a matter of pushing it somewhere
else and repointing our git origins...

We already depend on github for the online libraries, and we own a
kicad project for that (btw, I believe dick was set as administrator,  
but not sure if you’re not, let me know if that’s the case as I have
permissions).

But of course, it’s worth exploring other alternatives (specially if they
are free and open and we could eventually replicate them if something
goes wrong about github).

A plus of github is that it integrates very well with Jenkins to do  
Continuous Intregration, and checking pulls requests automatically.

>  
> - Convert all the existing documentation to asciidoc format. This
> includes any manual fixes due to incorrect translation. At some point I
> would also like to see the image file names changes to something
> meaningful rather than 10000000000000400000001FB5B88EB2.png. This can
> be done as images are changed.
>  
> - CMake configuration to check for all build dependencies, build all
> required output types, and handle translations. We will most likely
> have to support PDF output for the next release. I don't know if html
> help is supported in kicad. If it is, I'm open to the possibility of
> using html help instead of pdf.
>  
>  

>  
> Once the initial translation is complete and the repo is set up so
> people can submit patches, I will make an announcement that the official
> documentation has moved and see if I can configure the existing repo on
> launchpad as read only so no one can commit changes.
>  
> Cheers,
>  
> Wayne
>  
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to : kicad-developers@xxxxxxxxxxxxxxxxxxx (mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx)
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help : https://help.launchpad.net/ListHelp
>  
>  



References