search

NationalGenomicsInfrastructure / ngi_pipeline

Code driving the production pipeline at SciLifeLab
6 stars 24 forks source link

Improve documentation #56

Closed guillermo-carrasco closed 9 years ago

guillermo-carrasco commented 10 years ago

@vezzi your slides/mockups about what an engine/trigger/helper, etc. is would be a great addition to the README.md, as well as information about installation and functionalities.

Better not to leave this one for the far future!

guillermo-carrasco commented 10 years ago

What do you guys think about using the repos wiki for that?

https://github.com/NationalGenomicsInfrastructure/ngi_pipeline/wiki

pekrau commented 10 years ago

Seems sensible. /Per K

2014-08-25 12:06 GMT+02:00 Guillermo Carrasco notifications@github.com:

What do you guys think about using the repos wiki for that?

https://github.com/NationalGenomicsInfrastructure/ngi_pipeline/wiki

— Reply to this email directly or view it on GitHub https://github.com/NationalGenomicsInfrastructure/ngi_pipeline/issues/56#issuecomment-53247569 .

Per Kraulis, Ph.D. Systems Architect, National Genomics Infrastructure (NGI), SciLifeLab. Dept Biochemistry and Biophysics, Stockholm University. per.kraulis@scilifelab.se, +46 (0)8 5248 1465, http://www.scilifelab.se/ Visiting address: Tomtebodavägen 23A, Karolinska Institutet Science Park, Solna Mailing address: SciLifeLab Stockholm, Box 1031, 171 21 Solna, Sweden

guillermo-carrasco commented 9 years ago

you'll! I I've kind of changed my mind; Still think that the wiki is a ok idea. But reviewing the code I've seen that most of it is almost ready for ReadTheDocs, what about adding the rest of the documentation there?

mariogiov commented 9 years ago

Yeah dude I'm all up on the Sphinxy docs. Let's start with that. I don't know if it's all formatted properly and I'd better double-check to make sure it's all up to date as the code's been changing a lot but it's a good start. Still a kind of follow-the-code-flow doc would be good I think.

guillermo-carrasco commented 9 years ago

Absolutely, self documented code for the technical part, and verbose explanation for that follow-the-code-flow and main concepts.

guillermo-carrasco commented 9 years ago

This is auto generated by sphinx-quickstart, do you think I should pull request it? Otherwise when we start writing true documentation will be difficult to know which are our actual changes

guillermo-carrasco commented 9 years ago

I've linked this repo to ReadTheDocs, everytime we commit on the doc/ directory, the documentation will be rebuilt and shown here: http://ngi-pipeline.readthedocs.org/en/latest/