Add admin FAQ management UI #5

New issue

Open

opened 2024-01-14 14:14:14 -06:00 by jimmyb · 0 comments

jimmyb commented

2024-01-14 14:14:14 -06:00

Owner

Copy link

FAQs need an admin management UI in Laravel so staff can create, edit, organize, publish, unpublish, and remove FAQ content without editing code.

The current Laravel checkout has admin site-content navigation and placeholder pages for site news, but no FAQ persistence, model, admin routes, admin controller, or FAQ views. The public FAQ rebuild is tracked separately, so this issue focuses on the admin-side CRUD foundation that will let the public Help/Support FAQ page render managed content once connected.

Scope

FAQ database persistence and model.
Admin FAQ index, create, edit, update, publish/unpublish, and delete/restore behavior.
Admin sidebar navigation under Site Content Management.
FAQ grouping/category, display order, question, answer, and published status.
Validation, authorization, empty states, and admin feedback messages.
Compatibility with the public FAQ page rebuilt under Help/Support.

Acceptance Criteria

Authorized staff can view an admin FAQ index from the admin sidebar.
Authorized staff can create FAQ entries with question, answer, group/category, display order, and published status.
Authorized staff can edit existing FAQ entries.
Authorized staff can publish and unpublish FAQ entries without deleting them.
Authorized staff can soft-delete FAQ entries, and deleted entries do not render publicly.
FAQ entries render in stable group/order order for public consumption.
Unauthorized users and guests cannot access FAQ management routes.
Validation errors are shown clearly for missing question, missing answer, invalid order, or invalid status.
The admin index includes search or filtering by question/status/group where practical.
Admin UI supports light/dark mode and follows existing Laravel/Tailwind admin layout patterns.

Test Coverage Required

Feature tests confirming authorized staff can view the FAQ index, create form, and edit form.
Feature tests for creating, updating, publishing, unpublishing, soft-deleting, and restoring FAQ entries.
Authorization tests confirming guests, unverified users, and unauthorized roles cannot manage FAQs.
Validation tests for required question, required answer, display order, group/category, and status fields.
Regression tests confirming unpublished or deleted FAQs are excluded from public FAQ output when the public page is connected.
Regression tests confirming admin sidebar FAQ link and active state render correctly.
Tests should use Pest and focused feature coverage.
Run the focused affected tests, then run vendor/bin/pint --dirty before closing the issue.

Progress Checklist

Admin dashboard layout exists
Site Content Management admin sidebar section exists
Admin placeholder patterns exist for future content tools
Public FAQ rebuild is tracked separately
Add FAQ persistence table and model
Add FAQ factory for tests
Add admin FAQ routes protected by existing admin auth/role middleware
Add admin FAQ controller/actions
Build FAQ index, create, and edit views using existing admin components
Add publish/unpublish and soft-delete/restore behavior
Add FAQ link and active state to admin sidebar
Expose published FAQ ordering for the public FAQ page
Add tests for CRUD, validation, authorization, sidebar state, and public filtering
Confirm FAQ management matches expected admin content-management behavior

FAQs need an admin management UI in Laravel so staff can create, edit, organize, publish, unpublish, and remove FAQ content without editing code. The current Laravel checkout has admin site-content navigation and placeholder pages for site news, but no FAQ persistence, model, admin routes, admin controller, or FAQ views. The public FAQ rebuild is tracked separately, so this issue focuses on the admin-side CRUD foundation that will let the public Help/Support FAQ page render managed content once connected. ## Scope - FAQ database persistence and model. - Admin FAQ index, create, edit, update, publish/unpublish, and delete/restore behavior. - Admin sidebar navigation under Site Content Management. - FAQ grouping/category, display order, question, answer, and published status. - Validation, authorization, empty states, and admin feedback messages. - Compatibility with the public FAQ page rebuilt under Help/Support. ## Acceptance Criteria - Authorized staff can view an admin FAQ index from the admin sidebar. - Authorized staff can create FAQ entries with question, answer, group/category, display order, and published status. - Authorized staff can edit existing FAQ entries. - Authorized staff can publish and unpublish FAQ entries without deleting them. - Authorized staff can soft-delete FAQ entries, and deleted entries do not render publicly. - FAQ entries render in stable group/order order for public consumption. - Unauthorized users and guests cannot access FAQ management routes. - Validation errors are shown clearly for missing question, missing answer, invalid order, or invalid status. - The admin index includes search or filtering by question/status/group where practical. - Admin UI supports light/dark mode and follows existing Laravel/Tailwind admin layout patterns. ## Test Coverage Required - Feature tests confirming authorized staff can view the FAQ index, create form, and edit form. - Feature tests for creating, updating, publishing, unpublishing, soft-deleting, and restoring FAQ entries. - Authorization tests confirming guests, unverified users, and unauthorized roles cannot manage FAQs. - Validation tests for required question, required answer, display order, group/category, and status fields. - Regression tests confirming unpublished or deleted FAQs are excluded from public FAQ output when the public page is connected. - Regression tests confirming admin sidebar FAQ link and active state render correctly. - Tests should use Pest and focused feature coverage. - Run the focused affected tests, then run `vendor/bin/pint --dirty` before closing the issue. ## Progress Checklist - [x] Admin dashboard layout exists - [x] Site Content Management admin sidebar section exists - [x] Admin placeholder patterns exist for future content tools - [x] Public FAQ rebuild is tracked separately - [ ] Add FAQ persistence table and model - [ ] Add FAQ factory for tests - [ ] Add admin FAQ routes protected by existing admin auth/role middleware - [ ] Add admin FAQ controller/actions - [ ] Build FAQ index, create, and edit views using existing admin components - [ ] Add publish/unpublish and soft-delete/restore behavior - [ ] Add FAQ link and active state to admin sidebar - [ ] Expose published FAQ ordering for the public FAQ page - [ ] Add tests for CRUD, validation, authorization, sidebar state, and public filtering - [ ] Confirm FAQ management matches expected admin content-management behavior

jimmyb added the

component: admin dashboard

component: faqs

type: feature

labels

2024-01-14 14:14:14 -06:00