-
Notifications
You must be signed in to change notification settings - Fork 49
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
Add Module Rating to the docs. #856
Conversation
Thanks for the screenshots. That makes review very easy! I like it.... only one suggestion in the badge description there is reference to "RTD" but no link to what it is. Perhaps it should link here: https://tripal.readthedocs.io/en/latest/dev_guide/rtd.html |
Co-Authored-By: laceysanderson <las166@mail.usask.ca>
i have OCD desires to add consistent punctutation (periods at the end of each list item). Otherwise im excited for this. |
Co-Authored-By: laceysanderson <las166@mail.usask.ca>
Updated version to include @almasaeed2010 suggestions and make punctuation consistent 😄 |
I think this is ready for commit, right? |
I noticed one more thing. Is there a reason for using links to the old tripal.info docs instead of using the RTD docs? For example, there is a link to http://api.tripal.info/api/tripal/tripal_chado%21api%21tripal_chado.query.api.inc/group/tripal_chado_query_api/3.x when newer docs exist at https://tripal.readthedocs.io/en/latest/dev_guide/chado.html |
It just felt right to link to the API documentation specifically when requiring them to use the API. These are not old docs -they have different content/purpose then the current RTD docs. |
that makes sense. We're a ways away from integrating the API into the RTD (although Stephen and i have both done so successfully with Breathe) so the tripal.info links are correct |
Great then I think this is ready :) |
I do see value in linking to the docs that @almasaeed2010 references. The API is great but it's not always easy to know how to piece it together and we do provide examples of proper usage of the API. Maybe we could link to both? |
Better changes were proposed and included.
I added the second reviewer approval. I think this is good to merge. |
Awesome! Thank you for all the feedback everyone! |
Documentation
Issue #774
Description
This PR adds the discussed module rating system to the docs. Additionally, it adds badges for the module rating system.
Testing?
This PR can be tested by building the docs and inspecting
NOTE: The markup for the badges cannot be easily tested at this point since the paths depend on this PR being merged...
Screenshots (if appropriate):