Comments (21)
I'm reassigning this to myself as I'm currently working on this documentation.
from medic-docs.
We may do this partially in #1784
from medic-docs.
@garethbowen is this issue related to dev or tech lead documentation? (I imagine we could use both, but could be separate authors)
from medic-docs.
@abbyad I was just thinking about tech lead documentation. It would fit in somewhere in medic-docs/configuration
from medic-docs.
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.
from medic-docs.
@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.
from medic-docs.
Will start work on this @ngamita
@abbyad I'll use the doc you've shared in #1480 as a starting point.
from medic-docs.
@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.
from medic-docs.
@sglangevin that would be great, I could definitely use some help with that. Thanks.
from medic-docs.
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.
from medic-docs.
@garethbowen I was hoping you could help with:
- Nools
- TaskGenerator
- Utils class
from medic-docs.
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?
from medic-docs.
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?
from medic-docs.
@abbyad Is this something you could do?
from medic-docs.
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.
from medic-docs.
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?
from medic-docs.
It looks extensive enough.
@newtewt Is that PR ready for review?
from medic-docs.
@garethbowen I'd say it's ready for review.
from medic-docs.
Assigned the PR to @abbyad for review.
from medic-docs.
PR approved, assigning to @newtewt to close this issue once it is merged.
from medic-docs.
Merged the sample config tests PR.
from medic-docs.
Related Issues (20)
- CONTRIBUTING.md file is missing for this repo HOT 2
- Document how to configure multimedia elements in forms HOT 3
- Accessing and interpreting client-side telemetry HOT 1
- Add information about the `known` field in documentation
- App Style Guide HOT 3
- Update Windows development instructions HOT 3
- "Creating a blank project" documentation not clear for initialise-project-layout HOT 3
- API / Interoperability documentation HOT 2
- Define documentation site functional requirements HOT 2
- Finalize documentation site index and ontology HOT 11
- Review and integrate currently available documentation into the new doc site for initial launch HOT 15
- exploration of available out-of-the-box documentation tooling options HOT 11
- Implementation of new documentation tooling based on exploration outcomes HOT 1
- conversion of existing documentation resources to markdown in preparation for improved site launch HOT 5
- CHT documentation site telemetry implementation HOT 3
- Gap analysis of existing documentation at time of improved site launch HOT 3
- Update documentation on linking child documents
- Develop initial documentation on creating contact forms HOT 3
- Hugo Investigation for Docs Squad HOT 1
- Remove medic-docs content transitioned to doc new site HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from medic-docs.