BCDevOps / developer-experience

This repository is used to track all work for the BCGov Platform Services Team (This includes work for: 1. Platform Experience, 2. Developer Experience 3. Platform Operations/OCP 3)
Apache License 2.0
8 stars 17 forks source link

WordPress Cloud PaaS site updates to facilitate user research testing #2261

Closed ty2k closed 2 years ago

ty2k commented 2 years ago

To enable our Service Design team to perform user testing on the BCGov Private Cloud Platform as a Service WordPress instance from GDX, code updates are required. March is the target for when user testing should begin.

Homepage wireframe:

Homepage wireframe

Landing page for Our Services wireframe:

Landing page for Our Services

Below is a detailed list of changes required for the entire site. Because we are focused on user testing, work with Theresa Putkey to decide which of these might be able to be faked for testing within the context of this ticket, and then spun off into a more detailed ticket to be completed prior to the site launching.

Additional context The site is using a BC Gov look and feel using a template from the GDX division. Stay within the confines of this template to the extent possible to facilitate future updates to this site.

Admin access is required. Admin access can be granted by an existing admin (Justin, Olena, Tyler, Theresa, etc). Login using the "Login with KeyCloak" link near the footer on the homepage.

As we using a hosted WordPress instance as a service from the GDX division, any code updates we make (integrations, style fragments, etc) need to be documented and committed to one of our GitHub repositories. Check if we have an existing one that makes sense, or start a new one like wordpress-cloud-paas.

Definition of done

ty2k commented 2 years ago

Content page templates Templates were added for two and three column content pages. This was done with the Duplicate Page plugin (vs a custom block pattern, for example). Content creators will duplicate these template pages and rename them accordingly.

Content page layout We played with two options for H1 headings: using the included auto-generated H1 heading that sits atop the content page, and disabling that heading in order to manually create the H1 heading at the top of the central content column. It was decided that we would use the auto-generated option because it was simpler and looked better at all screen sizes when there was a longer page title.

Alerts I've added an HTML block to the homepage to show a single "warning" alert. Ideally, this should become a custom block (via a plugin) if more than one instance is required across the site.

Header CSS was added via the Additional CSS menu to push the pre-header menu to the right.

Footer No action in this ticket as this was not a blocker for user testing.

Global header navigation vs left menu navigation In the header navigation, we stayed away from nesting child items past one level deep. For on-page left menu navigation, we went with custom List blocks and styling added to Additional CSS. The reusable blocks are named like Left Nav Menu - <Menu Name>. With this this structured, we are able to nest <ul> lists within <li> list items, giving us as many levels hierarchy as we want (though we are sticking with three). This is okay for testing purposes, but it's not ideal from an accessibility perspective, because we are not able to use semantic tags like <nav> to direct screen-readers to treat this list like a navigation block. We are also unable to collapse the menu with a hamburger icon button on mobile screen sizes. Functionality like this will need to be added with a custom plugin (if desired).

Platform status indicator I've added a static "All Systems Operational" indicator to the homepage, and created #2339 PaaS WordPress platform status indicator for future development.

Taxopress plugin No action taken as this was not a blocker for user testing.

Events list No action taken as this was not a blocker for user testing.

ty2k commented 2 years ago

Code repository for WordPress code snippets: https://github.com/bcgov/platform-services-wordpress