search

tapis-project / authenticator

BSD 3-Clause "New" or "Revised" License
1 stars 3 forks source link

Consider defining "SK" before use in README #35

Closed wesleyboar closed 2 months ago

wesleyboar commented 11 months ago

Consider defining the word "SK" in the README before using it.

Background [In the README, the word SK is used without definition.](https://github.com/tapis-project/authenticator/tree/v1.3.4#start-the-server-locally) Searching ["sk abbreviation" in google](https://www.google.com/search?q=SK+abbreviation) gave me off-topic results*. I learned, by asking devs, that it means "security kernel". The first [search](https://www.google.com/search?q=security+kernel+%28sk%29) result I found—that actually has "security and "sk" in it—was TAPIS docs*, so I think it might not be widespread enough to use without explanation. \* I understand my past Google searches may influence the results.
joestubbs commented 2 months ago

This is a good suggestion, thanks! I Have added something to the README. It is in the dev branch now but will make its way up as part of the 1.6.1 release.

joestubbs commented 2 months ago

Not sure when this got released but I did confirm it is in the latest version.