search

rokwire / safer-illinois-app

Source code repository of "Safer Illinois" App - the official COVID-19 app of the University of Illinois.
https://safer.illinois.edu/
Apache License 2.0
33 stars 23 forks source link

[DOCUMENTATION] Update README Format #727

Open sandeep-ps opened 2 years ago

sandeep-ps commented 2 years ago

Describe the usability issue

It's a little bit confusing what configurations are needed by which versions of the app.

To Reproduce

Steps to reproduce the behavior:

  1. Go to README.md
  2. If you look at the formatting, it isn't completely clear which versions or version ranges need specific configuration files.

Expected behavior

Please update the README or improve the formatting using heading hierarchies or horizontal rules to differentiate different sections related to config files. Thanks.

mihail-varbanov commented 2 years ago

Hi @sandeep-ps,

For /assets/configs.json.enc it says "NB: For versions prior to 2.8." For /assets/organizations.hook.json.enc it says "NB: For version 2.8 and later." For /assets/organizations.json.enc it says "NB: For version 2.8 and later."

In short, /assets/configs.json.enc is for backward support as the current version is 2.12.

As regards to /assets/organizations.hook.json.enc vs /assets/organizations.json.enc - they both work but currently we have not set up organization definitions anywhere on our backend so we currently use /assets/organizations.json.enc statically embedded for our builds.

I am not sure how heading hierarchies can make this more clear. I have no idea what is "horizontal rules". Could you please give a visual idea how this data could be presented less confusing?