Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write overall pipeline 2 documentation up (5hrs) #20

Open
matentzn opened this issue Jul 28, 2020 · 4 comments
Open

Write overall pipeline 2 documentation up (5hrs) #20

matentzn opened this issue Jul 28, 2020 · 4 comments
Assignees

Comments

@matentzn
Copy link
Contributor

5 hours documentation - overview document in markdown with links to the components.

@dosumis
Copy link
Member

dosumis commented Aug 24, 2020

Any progress on doc to review?

@matentzn
Copy link
Contributor Author

Nothing much no.. I didnt figure that was urgent (just important!)

https://github.com/VirtualFlyBrain/vfb-pipeline-config/blob/master/README.md

Its just a few hours of typing up what the scripts do and how to change them for common use cases. Were you looking for anything in particular? Else I was going to finish that later this week!

@dosumis
Copy link
Member

dosumis commented Aug 24, 2020

Later this week is fine. Think it will be useful to go through soonish to make sure I understand configs sufficiently.

@matentzn
Copy link
Contributor Author

matentzn commented Sep 1, 2020

Ok the first draft of documentation is complete: https://github.com/VirtualFlyBrain/vfb-pipeline-config/blob/master/README.md

@dosumis review this in your own time, and add documentation requests (more detailed docs on something that you care about) in a new tickets on this here repo.

@matentzn matentzn assigned dosumis and unassigned matentzn Sep 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants