chore(#620): move cht-conf readme file #1451
Conversation
| linkTitle: "Development" | ||
| weight: 1 | ||
| description: > | ||
| To develop a new action or improve an existing one, check the ["Actions" doc](https://github.com/medic/cht-conf/blob/main/src/fn/README.md). |
There was a problem hiding this comment.
Hey @tatilepizs , how can we describe 'Actions'?
There was a problem hiding this comment.
An action is a command that's part of cht-conf, that you may execute against a CHT instance (hence the requiresInstance field mentioned in that readme). It's invoked by app developers by running cht-conf <action-name> and they can be chained cht-conf <action-1> <action-2> <action-3>.
Each .js file in cht-conf/src/fn is an action.
Co-authored-by: mariachana_moturi <[email protected]>
Co-authored-by: mariachana_moturi <[email protected]>
|
@esthermmoturi, @jkuester , @m5r thank you all for your review and help to make this document better. ⭐ One thing that I am not clear about is the location, should I move all those files related to |
|
My vote is we keep things simple here initially and start with only adding two pages:
Later we can expand these pages to multiple sub-pages, etc as needed. |
|
Thanks @jkuester. I like the idea of keeping it simple for now. |
…md and core/overview/cht-conf.md
|
I'm sorry if this is confusing 😅 now we have only two new files. How does it look? |
Description
Move the
cht-confREADME file in a new section on the Contributor Handbookcht-conf #620
License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.