search

IHTSDO / snowstorm-lite

Snowstorm Lite FHIR Terminology Server
Other
12 stars 2 forks source link

Create tech stack docs (techstack.yml and techstack.md) #5

Open stack-file[bot] opened 6 months ago

stack-file[bot] commented 6 months ago

Adding tech stack documentation to allow anyone to easily see what is being used in this repo without digging through config files. Two files are being added: techstack.yml and techstack.md. techstack.yml contains data on all the technologies being used in this repo. techstack.md is a visualization of the YML file and displays the tech stack data in a pretty Markdown file.

💡 Protip: techstack.md contains a comment at the top of the file that the following README snippet (with and without the logos) at the top of the file as a comment:

<--- Readme.md Snippet without images Start --->

Tech Stack

IHTSDO/snowstorm-lite is built on the following main stack:

Full tech stack here

<--- Readme.md Snippet without images End --->

Get the code:

## Tech Stack
IHTSDO/snowstorm-lite is built on the following main stack:

- [Java](https://www.java.com) – Languages
- [Spring Framework](https://spring.io/projects/spring-framework) – Frameworks (Full Stack)
- [Logback](https://logback.qos.ch/) – Log Management
- [Apache Camel](https://camel.apache.org/) – Platform as a Service

Full tech stack [here](/techstack.md)

<--- Readme.md Snippet with images Start --->

Tech Stack

IHTSDO/snowstorm-lite is built on the following main stack:

Full tech stack here

<--- Readme.md Snippet with images End --->

Get the code:

## Tech Stack
IHTSDO/snowstorm-lite is built on the following main stack:

- <img width='25' height='25' src='https://img.stackshare.io/service/995/K85ZWV2F.png' alt='Java'/> [Java](https://www.java.com) – Languages
- <img width='25' height='25' src='https://img.stackshare.io/service/2006/spring-framework-project-logo.png' alt='Spring Framework'/> [Spring Framework](https://spring.io/projects/spring-framework) – Frameworks (Full Stack)
- <img width='25' height='25' src='https://img.stackshare.io/service/2923/05518ecaa42841e834421e9d6987b04f_400x400.png' alt='Logback'/> [Logback](https://logback.qos.ch/) – Log Management
- <img width='25' height='25' src='https://img.stackshare.io/service/3276/xWt1RFo6_400x400.jpg' alt='Apache Camel'/> [Apache Camel](https://camel.apache.org/) – Platform as a Service

Full tech stack [here](/techstack.md)
kaicode commented 6 months ago

I do not think this PR adds any value to this project. The Technical Details section of the existing readme contains better information.

In fact this autogenerated file is misleading because it's missing key dependencies (HAPI-FHIR) and includes some that are not used at all (Apache Camel).

We already say that it uses Spring Boot (as all our java apps do). The logging library is not interesting.

kaicode commented 3 months ago

@jimcornmell is there a strong desire to standardise our projects using this autogenerated tech stacks or is this still in review? (See my comments above). Happy to standardise if the decision has already been made!