salilab / IHMValidation

Validation software for integrative models deposited to PDB
MIT License
2 stars 2 forks source link

Update validation documentation on PDB-Dev website #78

Open brindakv opened 3 months ago

brindakv commented 3 months ago

About validation and Validation help pages on the PDB-Dev website need to be updated for version 1.1.

aozalevsky commented 3 months ago

@brindakv Wow, it took me much longer than I had anticipated.

Long story short:

  1. I generated an updated Validation help page and put it on the beta server:

New: https://pdb-dev-beta.wwpdb.org/validation_help.html Old: https://pdb-dev-beta.wwpdb.org/validation_help.html.bak.20240321.html

  1. I generated an updated About validation page and put it on the beta server:

New: https://pdb-dev-beta.wwpdb.org/about_validation.html Old: https://pdb-dev-beta.wwpdb.org/about_validation.html.bak.20240321.html

Under the hood, I had to rewrite them, so they are now truly programmatically generated, including page layout and version. Since it also involved HTML templates for main pages too, I don't want to put it into the main repo yet (where we have a current version of the pipeline tested by you). Right now the code is in my fork aozalevsky/IHMValidation@c9bd499 and I'm aiming to merge it to the main repo early next week.

In the meantime, if you are ok with the pages on the beta site, you can add them to the website repo.

Let me know if you have any comments/suggestions.