Skip to content

Start documenting the validator api#6

Draft
laceysanderson wants to merge 2 commits intomasterfrom
5-validatorSetup
Draft

Start documenting the validator api#6
laceysanderson wants to merge 2 commits intomasterfrom
5-validatorSetup

Conversation

@laceysanderson
Copy link
Member

Issue #5

This PR will document the TripalCultivate Validator plugins and how they are used both for ourselves and to help anyone who may want to extend our modules.

  • Create a category for developer docs. I decided to put them in an "Extending functionality" section underneath the "Administration" documentation.
  • Create a "Validators" page including a very short intro and links to expected background understanding.
  • Document "What are Validators?". I started this but ran out of time to finish. Additionally there is currently a placeholder for a screenshot that I did not have time to setup a docker to take.
  • Document "How are validators used by a Tripal Importer?"
  • Create an image describing the flow of validation and the interaction between the importer and validator instances.
  • Document the existing validators, when you will want to use them, what setters are needed and what process* methods are available.
  • Think more about what else we should document and extend this checklist

Testing

Now that we have a docker for the docs we can test this locally as follows:

  1. clone this branch locally
  2. open the clone in vscode and choose to "Reopen in container"
  3. once the container has built, go to ports and open it up in your browser.
  4. Now navigate in your local copy of the site to Administration > Extending Functionality and review the content on this page.
  5. Next, navigate to the Validators section under "Extending Functionality" and review the content on this page.

I expect it to look something like this currently.

Screenshot 2025-05-07 at 2 46 19 PM

Firefox_Screenshot_2025-05-07T20-47-14 438Z

@laceysanderson laceysanderson linked an issue May 7, 2025 that may be closed by this pull request
@laceysanderson laceysanderson self-assigned this May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the validator setup for developers

1 participant