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

[Dashboard] Update Readme post-refactor for 23 release #6467

Closed
christinerogers opened this issue May 4, 2020 · 6 comments · Fixed by #6632
Closed

[Dashboard] Update Readme post-refactor for 23 release #6467

christinerogers opened this issue May 4, 2020 · 6 comments · Fixed by #6632
Assignees
Labels
Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) State: Needs documentation PR that needs a more exhaustive documentation to proceed

Comments

@christinerogers
Copy link
Contributor

christinerogers commented May 4, 2020

Module readme needs an update since it was refactored in jan 2020 #5896

Several issues linked below have been created to update the widget modules' testplans to add test cases for the their respective widgets.

After all issues are resolved and PRs merged, the dashboard readme and testplan should undergo a sanity check to make sure it is up to date with the new widget structures.

The below text could be handy -- This change was partially described by Dave's comment quoted below on #6464

The dashboard test plan was written before the module used any widgets, and no longer houses the code being tested. There are many things you can do now which affect what shows up in the dashboard without the dashboard knowing anything about it.. write a new module for a project which has widgets, disable/enable an existing module in the module manager, override a (non-dashboard) module which is one of the ones that provides widgets.. it's also easier to have someone test the related functionality to a module in the dashboard when testing that module than have someone setup and test (effectively) every module in LORIS at the same time for the "dashboard" test.

The tickets came up when I made tickets for the candidate_profile widgets that are missing documentation since the dashboard and candidate_profile use the same getWidgets() function.

Originally posted by @driusan in #6464

@johnsaigle
Copy link
Contributor

I didn't know you could make issue titles this long

@christinerogers christinerogers changed the title The dashboard test plan was written before the module used any widgets, and no longer houses the code being tested. There are many things you can do now which affect what shows up in the dashboard without the dashboard knowing anything about it.. write a new module for a project which has widgets, disable/enable an existing module in the module manager, override a (non-dashboard) module which is one of the ones that provides widgets.. it's also easier to have someone test the related functionality to a module in the dashboard when testing that module than have someone setup and test (effectively) every module in LORIS at the same time for the "dashboard" test. [Dashboard] Update Readme post-refactor for 23 release May 4, 2020
@christinerogers
Copy link
Contributor Author

I didn't know you could make issue titles this long

it was auto-generated by github lol

@christinerogers christinerogers added 23.0.0-testing State: Needs documentation PR that needs a more exhaustive documentation to proceed Critical to release PR or issue is key for the release to which it has been assigned labels May 4, 2020
@ridz1208
Copy link
Collaborator

ridz1208 commented May 6, 2020

Below are a list of issues created for this. I can see that updating the testplan of dashboard was missed in a couple of them. We should create specific issues to make sure the testplan sections are transferred to the proper module and the dashboard testplan is updated.

#6443
#6441
#6440
#6438
#6437
#6436
#6434

@ridz1208
Copy link
Collaborator

ridz1208 commented May 6, 2020

I think at this stage we should wait to get all the remaining PRs in and do a sanity check after to remove what is left over.

I added some details to the issue description

@ridz1208 ridz1208 removed their assignment May 6, 2020
@ridz1208
Copy link
Collaborator

@SantiagoTG @HenriRabalais you are both assigned to the dashboard testing in this round. As part of your testing can you make sure the dashboard test_plan and readme are up to date in reference tot the widgets which were moved to their respective modules ?

@HenriRabalais
Copy link
Collaborator

Added two new issues relating to adding documentation for the widgets in their respective modules:
#6631
#6630

These issues, along with the ones listed by Rida should cover all modules that have widgets that are used in the dashboard.

For reference, here is the full list of issues still open:
#6438
#6437
#6631
#6630

@driusan driusan removed the Critical to release PR or issue is key for the release to which it has been assigned label Jun 2, 2020
driusan pushed a commit that referenced this issue Aug 5, 2020
Update the Dashboard Testplan to reflect the fact that the widgets found on the Dashboard should be tested on the Modules from which they are provisioned.

Removed everything from the Testplan that I believe to be under the purview of another module.

Also added a small section to the README request which mentions the interaction with other modules through the widget.

    Resolves #6467
spell00 pushed a commit to spell00/Loris that referenced this issue Aug 13, 2020
Update the Dashboard Testplan to reflect the fact that the widgets found on the Dashboard should be tested on the Modules from which they are provisioned.

Removed everything from the Testplan that I believe to be under the purview of another module.

Also added a small section to the README request which mentions the interaction with other modules through the widget.

    Resolves aces#6467
AlexandraLivadas pushed a commit to AlexandraLivadas/Loris that referenced this issue Jun 15, 2021
Update the Dashboard Testplan to reflect the fact that the widgets found on the Dashboard should be tested on the Modules from which they are provisioned.

Removed everything from the Testplan that I believe to be under the purview of another module.

Also added a small section to the README request which mentions the interaction with other modules through the widget.

    Resolves aces#6467
AlexandraLivadas pushed a commit to AlexandraLivadas/Loris that referenced this issue Jun 29, 2021
Update the Dashboard Testplan to reflect the fact that the widgets found on the Dashboard should be tested on the Modules from which they are provisioned.

Removed everything from the Testplan that I believe to be under the purview of another module.

Also added a small section to the README request which mentions the interaction with other modules through the widget.

    Resolves aces#6467
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation PR or issue that aims to improve the documentation (test plans, wiki, comments...) State: Needs documentation PR that needs a more exhaustive documentation to proceed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants