Task configuration documentation

[garethbowen]

Task configuration documentation

[sglangevin]

I'm reassigning this to myself as I'm currently working on this documentation.

[estellecomment]

We may do this partially in #1784

[abbyad]

@garethbowen is this issue related to dev or tech lead documentation? (I imagine we could use both, but could be separate authors)

[garethbowen]

@abbyad I was just thinking about tech lead documentation. It would fit in somewhere in medic-docs/configuration

[abbyad]

Thanks, that's good. @ngamita, assigning to you to start building it out with the tech leads. Other product team members can help fill out key pieces where needed.

[ngamita]

@abbyad received - adding @smbuthia as we had already started something related to this and he will lead us on this as he is the documentation master on techleads team.

[smbuthia]

Will start work on this @ngamita
@abbyad I'll use the doc you've shared in #1480 as a starting point.

[sglangevin]

@smbuthia I can help out with task documentation if you'd like. Happy to review or help add content as needed - just let me know.

[smbuthia]

@sglangevin that would be great, I could definitely use some help with that. Thanks.

[sglangevin]

I've pushed a first draft of this to medic-docs. It doesn't cover everything that @garethbowen mentioned in the issue, but it's got a good amount of information on configuring tasks. Anyone want to volunteer to write an overview of Nools, TaskGenerator, and Utils functions? I can probably help out with the Utils stuff but don't know as much about Nools and TaskGenerator.

[sglangevin]

@garethbowen I was hoping you could help with:

• Nools
• TaskGenerator
• Utils class

[garethbowen]

I've added documentation about nools and nootils (in particular).

@alxndrsn Could you please add some documentation to https://github.com/medic/medic-docs/blob/master/configuration/tasks.md about how to write test task and target configuration?

[alxndrsn]

how to write test task and target configuration?

If this means "writing tests for task and target configuration", perhaps @abbyad already has something covering this?

[garethbowen]

@abbyad Is this something you could do?

[abbyad]

I can help write this but think we should wait until we've reviewed the tests to do so. We might refactor and have a bit more of a framework for tests by then.

[abbyad]

We now have this overarching documentation.

As for tests, @newtewt wrote this: medic/cht-core#4851

@garethbowen does that documentation cover everything to close this issue once that PR is merged?

[garethbowen]

It looks extensive enough.

@newtewt Is that PR ready for review?

[newtewt]

@garethbowen I'd say it's ready for review.

[garethbowen]

Assigned the PR to @abbyad for review.

[abbyad]

PR approved, assigning to @newtewt to close this issue once it is merged.

[newtewt]

Merged the sample config tests PR.