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

Add Module Rating to the docs. #856

Merged
merged 5 commits into from
Feb 25, 2019
Merged

Conversation

laceysanderson
Copy link
Member

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

  • Extensions > Tripal Module Rating System
  • Extensions > Adding your Module to this list!
  • Developers Guide > Module Development Best Practice

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):

screen shot 2019-02-19 at 9 59 58 pm
screen shot 2019-02-19 at 10 00 12 pm

@laceysanderson laceysanderson added Tripal 3 Any issue or pull requuest focused on Tripal 3 documentation labels Feb 20, 2019
@spficklin spficklin added the PR - Reviewer #1 Approval Used for pull requests to indicate approval by the first reviewer label Feb 20, 2019
@spficklin
Copy link
Member

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

docs/extensions/module_rating.rst Outdated Show resolved Hide resolved
Co-Authored-By: laceysanderson <las166@mail.usask.ca>
docs/extensions/module_rating.rst Outdated Show resolved Hide resolved
docs/extensions/module_rating.rst Outdated Show resolved Hide resolved
docs/extensions/module_rating.rst Outdated Show resolved Hide resolved
@bradfordcondon
Copy link
Member

i have OCD desires to add consistent punctutation (periods at the end of each list item). Otherwise im excited for this.

@laceysanderson
Copy link
Member Author

Updated version to include @almasaeed2010 suggestions and make punctuation consistent 😄

@spficklin
Copy link
Member

I think this is ready for commit, right?

@almasaeed2010
Copy link
Contributor

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

@laceysanderson
Copy link
Member Author

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.

@bradfordcondon
Copy link
Member

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

@almasaeed2010
Copy link
Contributor

Great then I think this is ready :)

@spficklin
Copy link
Member

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?

@laceysanderson
Copy link
Member Author

True, added more links to the RTD docs. More links to docs is never a bad thing 😄

screen shot 2019-02-24 at 8 52 37 am

@spficklin spficklin dismissed their stale review February 25, 2019 16:52

Better changes were proposed and included.

@spficklin spficklin added the PR - Reviewer #2 Approval Used for pull requests to indicate approval by the second reviewer label Feb 25, 2019
@spficklin
Copy link
Member

I added the second reviewer approval. I think this is good to merge.

@laceysanderson laceysanderson merged commit 209c428 into 7.x-3.x Feb 25, 2019
@laceysanderson laceysanderson deleted the 774-module-rating-system branch February 25, 2019 17:09
@laceysanderson
Copy link
Member Author

Awesome! Thank you for all the feedback everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR - Reviewer #1 Approval Used for pull requests to indicate approval by the first reviewer PR - Reviewer #2 Approval Used for pull requests to indicate approval by the second reviewer Tripal 3 Any issue or pull requuest focused on Tripal 3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants