tumblr / collins

groovy kind of love
tumblr.github.com/collins
Apache License 2.0
571 stars 99 forks source link

Document changes around encrypted tags permissions. #487

Closed william-richard closed 7 years ago

william-richard commented 7 years ago

Code PR: https://github.com/tumblr/collins/pull/486

byxorna commented 7 years ago

Where are the docs for canWriteEncryptedTags? I think breaking the changes to _includes/configuration/features.html into 2 separate bullets would make things clearer?

william-richard commented 7 years ago

I thought about this too while I was writing up these changes. Technically, _includes/configuration/features.html is for documenting the features, i.e. the encrypted_tags configuration, not permissions. We also say here that the permissions are documented under the api endpoints that use each permission. As such, I added docs to the api page about the new permissions I added: https://github.com/tumblr/collins/pull/487/files#diff-575a803dd8f76bb5f51928e633cd8548R100

I agree, it isn't very clear. But I think that's mostly because the docs around permissions are not very clear. I would be OK adding a new section that documents each permissions and what it does separately from the API docs, or doing something else to try to document permissions better.