Skip to content

Commit

Permalink
chore(#1626): update the get started steps for developer contributors (
Browse files Browse the repository at this point in the history
  • Loading branch information
andrablaj authored Oct 17, 2024
1 parent 1313b4f commit bac3b2d
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 17 deletions.
20 changes: 11 additions & 9 deletions content/en/contribute/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,26 @@ There are many ways to contribute to the Community Health Toolkit.
### Are you a developer?

The [Development](https://forum.communityhealthtoolkit.org/c/support/development/7) section of the forum is a great place to introduce yourself and ask questions. Or you can also jump right in:
- Issues labeled [help wanted](https://github.com/medic/cht-core/issues?q=is%3Aopen%20is%3Aissue%20label%3A%22Help%20wanted%22) are a great place to start.
- Learn to [build and host apps]({{% ref "building" %}}), and share your experiences
- [Share a new idea or question](https://forum.communityhealthtoolkit.org/) on our Forum
- [Get up to speed]({{% ref "technical-resources" %}}) with the technologies and tools used by the CHT. Additionally, the [Technology Radar for CHT Contributors](https://docs.communityhealthtoolkit.org/cht-tech-radar-contributors/) gives an overview of the technologies used to build the CHT tools.
- [Request a demo](https://communityhealthtoolkit.org/contact) to test out the CHT (login details will be emailed to you).
- Issues labeled [help wanted](https://github.com/medic/cht-core/issues?q=is%3Aopen%20is%3Aissue%20label%3A%22Help%20wanted%22) are a great place to start coding.
- Learn to [build and host apps]({{% ref "building" %}}), and share your experiences.
- [Share a new idea or question](https://forum.communityhealthtoolkit.org/) on the Forum.

### Are you a researcher, designer, or health practitioner?

- [Share your expertise](https://forum.communityhealthtoolkit.org) on our Forum
- Sign up for our [newsletter](https://communityhealthtoolkit.org/contact) to get the latest updates
- [Share your expertise](https://forum.communityhealthtoolkit.org) on the Forum.
- Sign up for the [newsletter](https://communityhealthtoolkit.org/contact) to get the latest updates.

### Are you a partner wondering how issues are prioritized?

There are a number of factors that contribute to prioritization of work. The following represents important factors that are often evaluated together to have the best chance for the largest impact if a partner will:

* Upgrade to get the feature/bugfix
* Help validate, design and prototype the feature
* Upgrade to get the feature/bugfix.
* Help validate, design and prototype the feature.
* Offer a time-bound funding opportunity which may influence when something gets done, provided that it aligns with the CHT product vision.
* Be blocked by it for a major release or expansion
* Has users that are unable to use the CHT or experience it in a way that results in providing degraded care
* Be blocked by it for a major release or expansion.
* Has users that are unable to use the CHT or experience it in a way that results in providing degraded care.

Will get prioritized. Further, internally, a ticket may be needed to facilitate a release or perform important upgrades as is critical to do in the maintenance of software.

Expand Down
2 changes: 1 addition & 1 deletion content/en/contribute/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Code of Conduct"
linkTitle: "Code of Conduct"
weight: 4
weight: 3
description: >
The Code of Conduct for the CHT community
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/contribute/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Contributing Documentation"
linkTitle: "Documentation"
weight: 1
weight: 2
description: >
How to contribute to documentation for the CHT
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/contribute/medic/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "At Medic"
linkTitle: "At Medic"
weight: 5
weight: 6
description: >
Compilation of guidelines and product development processes used at Medic
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/contribute/medic/onboarding/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ title: "Onboarding"
linkTitle: "Onboarding"
weight: 3
description: >
Onboarding resources for new contributors
Onboarding resources for new Medic contributors
---
2 changes: 1 addition & 1 deletion content/en/contribute/medic/onboarding/all-the-things.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Medic relies on both restricted and unrestricted funds to support our mission.
* Continuous Integration (CI) with GitHub Actions
* No Continuous Deployment, as no SaaS setup
* Sonar for [Code Static Analysis]({{% ref "contribute/code/static-analysis" %}})
* [Technical resources & learning material]({{% ref "contribute/medic/onboarding/technical-resources" %}}) for CHT contributors.
* [Technical resources & learning material]({{% ref "contribute/technical-resources" %}}) for CHT contributors.

#### GitHub
* Tons of things happen here.
Expand Down
2 changes: 1 addition & 1 deletion content/en/contribute/tech-radar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CHT Technology Radars"
linkTitle: "Tech radar"
weight: 3
weight: 6
description: >
CHT Technology Radars for Contributors and Implementers
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
---
title: "Technical Resources"
linkTitle: "Technical Resources"
weight: 3
weight: 5
description: >
Resources to get started as a contributor to the CHT
aliases:
- /contribute/medic/onboarding/technical-resources
---

This page contains materials that will help a CHT Contributor to learn the technical details they need to be successful when building tools related to the CHT.

Keep in mind that this is a living document, and every contributor is encouraged to add to it when identifying learning opportunities that can set them up for success with the CHT. The main goal here is to provide the technical people who are new to the CHT with a list of resources that could be beneficial for them in both the short and long term. However, the expectation is not to complete every course listed in this document but instead to share some resources that other contributors found helpful. It is valid if you prefer to use other training material, as long as you cover the skill/topic during the onboarding. That means you will need to learn JavaScript, TypeScript, Docker, CouchDB, and others mentioned in the “Skills” column, as you will use them in your day-to-day activities, and the list provided in the “Resources” column is meant to support you in this. It is OK if you prefer to learn with alternative resources.

## Developer Workshops
There is a Slack channel *#cht-dev-workshop* for CHT community members to grow their coding skills. The group meets on a weekly basis. The primary goal of this group is to discuss with other developers and have a fun, open discussion on how the provided solutions can be improved, while also having the opportunity to connect with people from other teams. Even though this is optional, it is highly encouraged to join and participate frequently.
There is a Slack channel in the Medic Workspace called *#cht-dev-workshop* for CHT community members to grow their coding skills. The group meets on a weekly basis. The primary goal of this group is to discuss with other developers and have a fun, open discussion on how the provided solutions can be improved, while also having the opportunity to connect with people from other teams. Even though this is optional, it is highly encouraged to join and participate frequently.

## Technical Resources

Expand Down

0 comments on commit bac3b2d

Please sign in to comment.