The template structure has grown organically over the years, and this PR realigns it with the structure of the site and applies some consistent naming and directory structure conventions
Categorisation
This PR...
[ ] has scripts to run
[ ] has migrations to run
[ ] adds new infrastructure
[ ] changes the CI pipeline
[x] affects the public site
[x] affects the editorial area
[x] affects the publisher area
[ ] affects the monitoring
Basic PR Checklist
Instructions for developers:
For each checklist item, if it is N/A to your PR check the N/A box
For each item that you have done and confirmed for yourself, check Developer box (including if you have checked the N/A box)
Instructions for reviewers:
For each checklist item that has been confirmed by the Developer, check the Reviewer box if you agree
For multiple reviewers, feel free to add your own checkbox with your github username next to it if that helps with review tracking
Code Style
No deprecated methods are used
[x] N/A
[ ] Developer
[ ] Reviewer
No magic strings/numbers - all strings are in constants or messages files
[ ] N/A
[x] Developer
[ ] Reviewer
ES queries are wrapped in a Query object rather than inlined in the code
[x] N/A
[ ] Developer
[ ] Reviewer
Where possible our common library functions have been used (e.g. dates manipulated via dates)
[x] N/A
[ ] Developer
[ ] Reviewer
Cleaned up commented out code, etc
[ ] N/A
[x] Developer
[ ] Reviewer
Urls are constructed with url_for not hard-coded
[x] N/A
[ ] Developer
[ ] Reviewer
Testing
Unit tests have been added/modified
[x] N/A
[ ] Developer
[ ] Reviewer
Functional tests have been added/modified
[x] N/A
[ ] Developer
[ ] Reviewer
Code has been run manually in development, and functional tests followed locally
[ ] N/A
[x] Developer
[ ] Reviewer
Have CSS/style changes been implemented? If they are of a global scope (e.g. on base HTML elements) have the downstream impacts of the change in other areas of the system been considered?
[x] N/A
[ ] Developer
[ ] Reviewer
Documentation
FeatureMap annotations have been added
[x] N/A
[ ] Developer
[ ] Reviewer
Documentation updates - if needed - have been identified and prepared for inclusion into main documentation (e.g. added and highlighted/commented as appropriate to this PR)
There has been a recent merge up from develop (or other base branch). List the dates of the merges up from develop below
2024-06-28
Testing
There are two sets of tests we should run here. The first is to visit every page in the site that uses the templating system, check that they render correctly, and that they look the same as the live site. I have made a test sheet for that here:
Restructure templates for easier future development
See https://github.com/DOAJ/doajPM/issues/3356
The template structure has grown organically over the years, and this PR realigns it with the structure of the site and applies some consistent naming and directory structure conventions
Categorisation
This PR...
Basic PR Checklist
Instructions for developers:
Instructions for reviewers:
Code Style
No deprecated methods are used
No magic strings/numbers - all strings are in
constants
ormessages
filesES queries are wrapped in a Query object rather than inlined in the code
Where possible our common library functions have been used (e.g. dates manipulated via
dates
)Cleaned up commented out code, etc
Urls are constructed with
url_for
not hard-codedTesting
Unit tests have been added/modified
Functional tests have been added/modified
Code has been run manually in development, and functional tests followed locally
Have CSS/style changes been implemented? If they are of a global scope (e.g. on base HTML elements) have the downstream impacts of the change in other areas of the system been considered?
Documentation
FeatureMap annotations have been added
Documentation updates - if needed - have been identified and prepared for inclusion into main documentation (e.g. added and highlighted/commented as appropriate to this PR)
Core model documentation has been added to if needed: https://docs.google.com/spreadsheets/d/1lun2S9vwGbyfy3WjIjgXBm05D-3wWDZ4bp8xiIYfImM/edit
Events and consumers documentation has been added if needed: https://docs.google.com/spreadsheets/d/1oIeG5vg-blm2MZCE-7YhwulUlSz6TOUeY8jAftdP9JE/edit
The docs for this branch have been generated and pushed to the doc site (see docs/README.md for details)
Release Readiness
If needed, migration has been created and tested locally
Release sheet has been created, and completed as far as is possible https://docs.google.com/spreadsheets/d/1Bqx23J1MwXzjrmAygbqlU3YHxN1Wf7zkkRv14eTVLZQ/edit
There has been a recent merge up from
develop
(or other base branch). List the dates of the merges up from develop belowTesting
There are two sets of tests we should run here. The first is to visit every page in the site that uses the templating system, check that they render correctly, and that they look the same as the live site. I have made a test sheet for that here:
https://docs.google.com/spreadsheets/d/1ALYt12_X0dG5bx5a2kt62BA1_ro_4GNmw1vhSzBy9BI/edit
Then we should run a few functional tests just to look in detail at the most critical areas of the site:
https://doaj.github.io/doaj-docs/feature/3356_restructure_templates/testbook/index.html#journal_form/maned_form/journal_form_test https://doaj.github.io/doaj-docs/feature/3356_restructure_templates/testbook/index.html#new_application_form/publishers_form https://doaj.github.io/doaj-docs/feature/3356_restructure_templates/testbook/index.html#public_site/home_page/launching_off_from_home_page
Deployment
What deployment considerations are there? (delete any sections you don't need)
Configuration changes
N/A
Scripts
N/A
Migrations
N/A
Monitoring
N/A
New Infrastructure
N/A
Continuous Integration
N/A