docs: improve readme #31
Conversation
|
|
||
| .. image:: https://img.shields.io/badge/Status-Maintained-brightgreen | ||
| - Tracks changes to specified models. | ||
| - Logs detailed information about create, update, and delete operations. | ||
|
|
||
| Installation |
There was a problem hiding this comment.
I think we should add information in this section about how to install this in Tutor, similar to the explanation here: eox-tenant installation. What do you think?
There was a problem hiding this comment.
Sorry for the delay, I forgot to answer.
I have a question about it because the audit model requires direct modification in the code (add the decorator or the method), should be recommended to be installed by tutor OPENEDX_EXTRA_PIP_REQUIREMENTS, or should be installed through the plugin or code that wants to use it?
There was a problem hiding this comment.
I agree with @magajh. I think it would be valuable to briefly explain how to install it with Tutor.
About your question @dcoa, I think that the way of installation we should recommend is with OPENEDX_EXTRA_PIP_REQUIREMENTS, so when you have that plugin installed, you can use it in your code as you prefer. Also, we already install audit-model using that config, e.g., audit-model in quince.
There was a problem hiding this comment.
@dcoa, please ping me when you've addressed this comment so I can leave my approval :)
There was a problem hiding this comment.
@MaferMazu @magajh I rewrote the installation instructions to use Tutor.
Thanks for your feedback :)
dcoa
force-pushed
the
dcoa/improve-docs
branch
3 times, most recently
from
744606b to
b9d6fba
Compare
|
@dcoa, thanks for this PR. It looks good to me. I only added a comment in the Tutor installation discussion, but that's it. Please let me know when you have resolved the conversations to retake a look. |
This PR improves the repository documentation for a better understanding of the eox-audit-model plugin.
For repo description, same as the readme.
Additional information
JIRA