Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCUMENTATION] Update README Format #727

Open
sandeep-ps opened this issue Sep 30, 2021 · 1 comment
Open

[DOCUMENTATION] Update README Format #727

sandeep-ps opened this issue Sep 30, 2021 · 1 comment
Assignees
Labels
Type: Documentation Improvements or additions to documentation

Comments

@sandeep-ps
Copy link
Collaborator

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.

@sandeep-ps sandeep-ps added the Type: Usability Usability label Sep 30, 2021
@sandeep-ps sandeep-ps added Type: Documentation Improvements or additions to documentation and removed Type: Usability Usability labels Sep 30, 2021
@sandeep-ps sandeep-ps changed the title [USABILITY] Update README Format [DOCUMENTATION] Update README Format Sep 30, 2021
@mihail-varbanov
Copy link
Collaborator

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants