tripal/t4d8

Group 9 - Documentation

Closed this issue · 3 comments

laceysanderson commented

The plan for Tripal 4 documentation is to provide a single resource for Tripal Users and Developers. Rather then documenting Tripal with the assumption you know Drupal, we are going to teach both Drupal/Tripal and provide links to core Drupal documentation for more information. This should make the Tripal 4 documentation an easier resource for PIs to point new developers at.

Idealistic Overview:

  1. Install Tripal
  2. Building your site: creating vocabularies, configuring pages...
  3. Guiding your users: creating content, searching...
  4. Site Administration: Importing data, administering users...
  5. Extending Tripal
  6. Upgrading Tripal
  7. How to Contibute (Tripal Community)

This issue is meant to be a general guiding idea not a master plan 😉

Please feel free to use this issue to mention concepts or functionality which you would love to see well documented!

laceysanderson commented

Documentation upgrades according to this plan should take place in branch 94-docs. The most recent docs generated from this branch can be viewed at https://tripal4.readthedocs.io/en/94-docs/ and will include all pushed changes to this branch within a couple of minutes.

laceysanderson commented

Core outline has been implemented in #96.

The Tripal Vocabularies/IDSpaces/Terms functionality is now done. As such we can make the documentation for how to use these through the UI.

Add a new page: "Setting up Tripal Vocabularies" to the "Building your Site" section of the new docs. This should include the following process:

  1. How to get to Tripal > Vocabularies (using the new Tripal menu bar)
  2. How to add the "Sequence Ontology" vocabulary.
  3. How to add the "SO" IDSpace.
  4. How to add the "gene" Term which is in the SO IDSpace and Sequence ontology.

Create the t4d8/docs/sitebuilding_guide directory and add the page to there. The RST guidelines for Tripal are here: https://tripal.readthedocs.io/en/latest/contributing/documentation.html#tripal-conventions. You will also need to add sitebuilding_guide/yournewpage to the toc tree in the sitebuilding_guide.rst

laceysanderson commented

Closing this issue as documentation has moved to the tripal_doc repository.