Closed dave-mills closed 1 year ago
I've added a HelpTextEntrySeeder to populate the database with most of the entries I think are needed, but I expect there'll be a few more to come. No need to wait for those for this PR.
I got latest code and executed below commands to setup my local env:
git checkout dev
git pull
git checkout guidance
git pull
php artisan migrate:status
php artisan migrate
execute two seeder file: RoleSeeder, HelpTextEntrySeeder
composer install
npm install
I found that the help text content is the same in two pages:
In Dashboard page, there is an incomplete in help text content.
The /admin/help-text-entry is not accessible....
I found that the help text content is the same in two pages:
My Institution > Portfolios My Institution > Settings
Fixed.
In Dashboard page, there is an incomplete in help text content.
The PR isn't really about the content of the help text, but yes - fixed in the seeder.
The /admin/help-text-entry is not accessible....
Issue with the widget definition syntax. Should be fixed in the latest commit.
Thank you Dave, the previous issues are fixed. Help text entry CRUD panel works fine now.
I found that there is no help_text_entries record for My Institution - Settings, therefore no help text content showed in front end now.
All other features work properly, I think it is good to merge.
Um.... I guess this should be a typo....
I have changed "My Institution - Settings" to "My Institution - Details", then it show help text content properly.
I have changed "My Institution - Settings" to "My Institution - Details", then it show help text content properly.
Ah! Well spotted, thanks for fixing that!
Deployment is completed in staging env.
Performed testing, some pages returned error 500. Export help_text_entries records from local db, import them into staging db. Problem resolved.
This PR adds the capacity for us to quikly add help text to anywhere within the application.
Instead of hard-coding the help text into the pages, I wanted to do 2 things:
Developer Tools
The first is achieved through a pair of blade components and vue components - I made both so we can use them on blade/php rendered pages and within Vue component pages.
x-help-text-link
andv-help-text-link
components display a?
symbol, and when clicked on either show the correspondingx-help-text-entry
/v-help-text-entry
collapsible component, or show a popover. The collapse is the default, and you can make it a popover by adding the attributetype="popover"
.location
attribute. This matches to a HelpTextEntry database entry, and will display thetext
property from that location.This means we can quickly add some help text to anywhere in the sytem by adding a database entry and the appropriate component in the right place/places.
Site Manager Tools
The HelpTextEntryCrudController shoiuld allow site managers to review and edit the HelpTextEntry items in the database.
This crud panel should be added to the back-end when we merge this in with #201.