stats4sd / aec_portfolio

A proof of concept for the AEC Consortium Project Management / Assessment System
GNU General Public License v3.0
0 stars 0 forks source link

Adds Help Text Helper + Guidance throughout system #207

Closed dave-mills closed 1 year ago

dave-mills commented 1 year ago

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:

  1. Make it quick for us to add new help text anywhere in the system.
  2. Allow Site Managers / Admins to edit the text shown from the admin panel.

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.

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.

dave-mills commented 1 year ago

Setup Notes

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.

dan-tang-ssd commented 1 year ago

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

dan-tang-ssd commented 1 year ago

I found that the help text content is the same in two pages:

image

image

dan-tang-ssd commented 1 year ago

In Dashboard page, there is an incomplete in help text content.

image

dan-tang-ssd commented 1 year ago

The /admin/help-text-entry is not accessible....

image

dave-mills commented 1 year ago

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.

dan-tang-ssd commented 1 year ago

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.

image

image

dan-tang-ssd commented 1 year ago

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.

image

dave-mills commented 1 year ago

I have changed "My Institution - Settings" to "My Institution - Details", then it show help text content properly.

Ah! Well spotted, thanks for fixing that!

dan-tang-ssd commented 1 year ago

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.