Skip to content

Commit

Permalink
chore: Update radar description page
Browse files Browse the repository at this point in the history
  • Loading branch information
@andrablaj
andrablaj committed Jan 26, 2024
1 parent 8dee87d commit 401854c
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 20 deletions.
4 changes: 2 additions & 2 deletions Readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,15 @@ The default is `/`.
### Build the radar
```
npm i
npm install
PUBLIC_URL=/build REACT_APP_RADAR_NAME="CHT Technology Radar for Implementers" npm run start
```

Then open the Tech Radar here: http://localhost:8080/build

### Build the radar with static files
```
npm i
npm install
PUBLIC_URL=/build REACT_APP_RADAR_NAME="CHT Technology Radar for Implementers" npm run start:static
```

Expand Down
6 changes: 3 additions & 3 deletions public/config.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@
"colour": "#7092F5",
"txtColour": "#444444",
"position": 1,
"description": "These are the components used for building CHT apps, like CHT Conf, and form preview/builder tools like XLSForm or any future GUI form builder versions."
"description": "These components help build CHT apps, like CHT Conf, and form preview/builder tools like XLSForm."
},
"methods-and-patterns": {
"colour": "#535EAA",
"txtColour": "white",
"position": 2,
"description": "These include tools and components used to manage data that comes in or out of the CHT. This includes integrations and interoperability standards and methods, as well as ETL, Pipeline, and querying methods. Also included in this quadrant are visualization tools for dashboards."
"description": "This includes tools and components used to manage data that comes in or out of the CHT. It also includes integrations, interoperability standards and methods, ETL, Pipeline, and querying techniques. Additionally, this quadrant contains visualization tools for dashboards."
},
"platforms-and-aoe-services": {
"colour": "#436D84",
"txtColour": "#444444",
"position": 3,
"description": "Deploying and maintaining CHT instances takes considerable coordination, especially for large scale deployments. This quadrant includes key aspects for hosting, including tools and methods for alerts and monitoring as well."
"description": "Deploying and maintaining CHT instances takes considerable coordination, especially for large-scale deployments. This quadrant also includes key aspects for hosting, including tools and methods for alerts and monitoring."
},
"tools": {
"colour": "#278489",
Expand Down
26 changes: 11 additions & 15 deletions public/messages.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,14 @@
{
"headline": "Introduction",
"values": [
"Technology is moving fast and new technologies and innovations appear continuously.",
"It's essential for a development toolkit such as the Community Health Toolkit to constantly improve and keep track with the latest useful innovations. It is important to openly look for innovations and new technologies and to question established technologies and methods every now and then.",
"But, it is also important to wisely choose which technologies to use in our daily work and in the different projects we are carrying out. As we all know: There is no silver bullet."
"It is essential for a development toolkit such as the Community Health Toolkit to constantly improve and keep track with the latest useful innovations. It is important to openly look for innovations and new technologies and to question established technologies and methods every now and then."
]
},
{
"headline": "What is the Technology Radar",
"values": [
"The CHT Technology Radar for Implementers provides a view of all CHT-related tools and components so that CHT implementers can decide which to use when designing, developing, and hosting their CHT applications."
"To enhance visibility and clarity on the technology choices, the technological strategy, and the available CHT features and tools, we leverage a framework called Technology Radar.",
"The CHT Technology Radar for Implementers provides an easy-to-grasp visual representation of tools, features and functionalities we use to build with the CHT. Additionally, the Technology Radar provides a degree of adoption and guidelines on using (or not using) a particular technology. The community can leverage it to answer questions like: Should we use couch2pg or cht-sync for our project?"
]
},
{
Expand All @@ -31,50 +30,47 @@
{
"headline": "How it is created",
"values": [
"The items in the technology radar are raised by the different contributors and therefore a lot of the items are related to the work and challenges the contributors face in the different projects. In fact, we don't include anything on the radar that we haven't tried ourselves at least once.",
"There have been a lot of valuable discussions in different expert groups about the classification and details of each of technologies and innovations. And the result of all this can be found in the latest technology radar."
"The items in the technology radar are raised by the different contributors and implemeters and therefore a lot of the items are related to the work and challenges the community faces in the different projects. "
]
},
{
"headline": "How should it be used",
"values": [
"The radar acts as an overview of technologies that we think everyone in the community should currently know about.",
"Its goal is to act as a guide and inspiration for the daily work in the community. Its purpose is also to provide helpful information and a bird's-eye perspective - so that decisions can be taken with a much deeper understanding of the subject matter. This results in more informed and coordinated decisions.",
"We also hope that developers outside of CHT Community find the information in our technology overview inspirational.",
"The radar acts as an overview of technologies that we think everyone in the CHT Community should currently know about. Its goal is to act as a guide in the community when contributing to the CHT. We also hope that developers outside of CHT Community find the information in our technology overview inspirational.",
"We group or categorize the items in 4 quadrants - (sometimes, when it's not 100% clear where a item belongs, we choose the best fit)."
]
}
],
"quadrants": [
{
"name": "App Building",
"description": "These are the components used for building CHT apps, like CHT Conf, and form preview/builder tools like XLSForm or any future GUI form builder versions."
"description": "These components help build CHT apps, like CHT Conf, and form preview/builder tools like XLSForm."
},
{
"name": "CHT App Features",
"description": "Aspects of CHT Core Framework that can be used in CHT Apps. These could include new CHT form widgets, updated UI elements like the floating action button, and user management features."
},
{
"name": "Data Use",
"description": "These include tools and components used to manage data that comes in or out of the CHT. This includes integrations and interoperability standards and methods, as well as ETL, Pipeline, and querying methods. Also included in this quadrant are visualization tools for dashboards."
"description": "This includes tools and components used to manage data that comes in or out of the CHT. It also includes integrations, interoperability standards and methods, ETL, Pipeline, and querying techniques. Additionally, this quadrant contains visualization tools for dashboards."
},
{
"name": "Deployment Management",
"description": "Deploying and maintaining CHT instances takes considerable coordination, especially for large scale deployments. This quadrant includes key aspects for hosting, including tools and methods for alerts and monitoring as well."
"description": "Deploying and maintaining CHT instances takes considerable coordination, especially for large-scale deployments. This quadrant also includes key aspects for hosting, including tools and methods for alerts and monitoring."
}
],
"rings": [
{
"name": "Adopt",
"description": "The Adopt ring represents tools that we think you should seriously consider using. We don't say that you should use these for every project; any tool should only be used in an appropriate context. However we do think that a blip in the Adopt ring represents something where there's no doubt that it's proven and mature for use."
"description": "The Adopt ring represents tools that you should seriously consider using. We don’t say you should use these for every project; one should only use a tool in an appropriate context. However, an item in the Adopt ring represents something where there’s no doubt it’s proven and mature for use with the CHT."
},
{
"name": "Trial",
"description": "The Trial ring is for tools that are ready for use, but not as completely proven as those in the Adopt ring. So for most organizations we think you should use these on a trial basis, to decide whether they should be part of your toolkit. Others may already be using these blips in production, likely as early adopters of the tools."
"description": "The Trial ring is for tools ready for use but only partially proven as those in the Adopt ring. You should use these on a trial basis to decide whether they should be part of your toolkit. Others may already be using these items in production, likely as early adopters of the tools."
},
{
"name": "Stop",
"description": "The Stop (or Not Recommended) ring is for things that we think implementers should hold off from using, or look for ways to move off of. We place things in the Stop ring that we wish the CHT Community wouldn’t use anymore."
"description": "The Stop (or Not Recommended) ring is for things we think implementers should avoid using or look for ways to move off of. These include items for which a better alternative is available, or where the item is found to not work correctly with the CHT."
}
],
"sourcecodeLink": {
Expand Down

0 comments on commit 401854c

Please sign in to comment.