From b015954331eaadf8af0346cac43f7ed23bf61cba Mon Sep 17 00:00:00 2001 From: Matt Barton Date: Thu, 28 Nov 2024 16:20:45 +0000 Subject: [PATCH 1/2] first draft of proposal --- pathways/pathways-approach-proposal.md | 103 +++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 pathways/pathways-approach-proposal.md diff --git a/pathways/pathways-approach-proposal.md b/pathways/pathways-approach-proposal.md new file mode 100644 index 00000000..830c2d14 --- /dev/null +++ b/pathways/pathways-approach-proposal.md @@ -0,0 +1,103 @@ +# Page rendering changes for Pathways training modules + +## Introduction + +The SfSW website has always been used to render web pages which are very stand-alone and individual. The CMS allows for pages to link to each other, and in that way informal groupings of pages can be made. + +However the new designs for pages in the Pathways programme require a new approach which provides a greater context for pages to sit within. Each pathways training module has pages of different types, and these types are common across all training modules. + +## New page rendering approach + +The following approach will enable the implementation of the proposed designs for the Pathways training modules, without requiring too much manual input from the Contentful user. By specifying content and page types, we are able to include in rendered pages specific standard elements on a given type of page in the training module. For example, the inclusion of navigation buttons, including their styling and where they take the end user to. + +## Required changes to Contentful: + +### “Content” content type + +Within the ‘Content’ content type, there will be two new fields: + +1. Pathway module +2. Page type + +Pathway module (optional) +Defines which module this page belongs to? e.g. ‘Pathway 1’ +The Contentful user categorises the page into a specific pathway. +The user will also need to select one of two options: *Regular module* or *Introductory module*. This is because the design and structure of these differ. +Data type: Reference + +Page type (optional) +Defines what specific role this page performs \- e.g. a ‘Pathways: intro page’ will have a ‘Start module’ button. A ‘Pathways: training content’ page will likely have ‘Previous’ and ‘Next’ buttons. A ‘Standard page’ won’t have any additional items on it. +Data type: String/Select + +### Pathway Module (new content type) + +The Pathway Module content type defines the pages and metadata that describe a Pathways training module. The metadata includes a name for the module, the type of module that is being represented (standard training module or an introductory module with a restricted set of pages), at least one Pathways Module Section (see below), and a number of additional pages, such as the frontmatter and endmatter pages. + +### Pathway Module Section (new content type) + +Each Pathway Module will contain at least one of these new Pathway Module Sections. These are grouped sets of training pages, each with a title and a summary. + +The titles and summaries of the Pathway Module Sections in a Pathway Module will be used to generate (among other things) the Module Index for the module, which gets displayed on the module’s Contents page. + +### Structure diagram (draft)![][image1] + +## List of required changes (in indicative priority order): + +* **Create content types for module and section, and amend Content content type** + * Amend “Content” content type + * Add optional Training Module field as a single-select link to the Training Module content type + * Add Type field, with options: + * Pathways: Overview + * Pathways: Contents + * Pathways: Training Content + * Pathways: Declaration + * Pathways: Certificate + * Standalone Page + * Create Training Module content type with fields: + * Name (short string) + * Module Type (single-select, options: + * Regular Module + * Introductory Module) + * Overview Page (single-select link item to Content content type) + * Contents Page (single-select link item to Content content type) + * Modules (multi-select link item to Module Section content type) + * Declaration Page (single select link item to Content content type) + * Certificate Page (single select link item to Content content type) + * Create Module Section content type with fields: + * Name (short string) + * Summary (long string) + * Pages (multi-select link item to Content content type) + +* **Create Contents Page rendering (including Module Index and “Start from the beginning” button)** + * Create the page rendering for a page of type “Pathways: Contents”, which renders the page items as configured in the page, and then two standard items: + * Green button with label “Start from the beginning of the pathway \>” which navigates the user to the first page in the first Module Section + * Module Index item which enumerates each of the sections in the Training Module, each detailing its name and summary, number of pages in the section, and a link to the first page of the section (see designs for details of how enumeration should displayed) + +* **Create Main training content page rendering (including Next/Previous button)** + * Create page rendering for pages of type “Pathways: Training Content”, which renders the page items as configured in the page, and then navigation buttons as appropriate for the page’s position in the Training module: + * The first page in the Training Module should have two buttons “Previous” and “Next”. Previous should navigate back to the contents page, “Next” should navigate to the next page in the Training Module + * The last page in the Training Module should have two buttons “Previous”, which navigates back to the previous training page, and then a button which is dependent on the type of module the page belongs to. For modules of type “Regular Module” the button text should be “Get your certificate” and it should navigate to the Declaration page. For modules of type “Introductory Module” it should read “Go back to all Pathways” and navigate to the Pathways hub page + * Other main training content pages, those that are not the very first or very last should have two buttons “Previous” and “Next” which navigate to the previous or next training content pages in the module + * See Figma designs for specifics on button appearance + +* **Create Pathway Overview page rendering (including “Start Pathway” button)** + * Create page rendering for the page which is specified as a Training Module’s Overview page which renders the page items as configured and then a button labelled “Start Module” for overview pages of modules of type “Introductory Module” or “Start pathway” for any other module. This button should navigate to the modules’ Contents page + + +* **Create declaration page rendering (including 'Previous' and 'Go back to All pathways' buttons)** + * Create page rendering for the page which is specified as a module’s Declaration page. It should render all of the content specified in the Figma design for the pathway declaration page, including a checkbox which the user needs to click before being able to press the “Get your certificate \>” button. This should use javascript to enable the button, but needs to degrade gracefully in browsers with no javascript, replacing the checkbox with a statement saying that by clicking the button you’re confirming the statements in the page contents. + +* **Create certificate page rendering (including 'Go to All pathways' button)** + * Create page rendering the training module Certificate page per the Figma designs + +* **Create breadcrumb alternative for training module page** + * Alter the page rendering for all Training Module pages so that the page breadcrumbs are replaced with a single link navigating back to the training module’s overview page per the Figma designs + +* **Create location indicator in page banner (“Section 1 of 5”)** + * Alter the page rendering for pages of type “Pathways: Training Content” so that the page’s location in terms of the current section and total number of secretions are detailed per the Figma designs + + +* **Create progress bar in page banner** + * \ + +[image1]: \ No newline at end of file From ca658b41d66afd4a9567c176968b2c799e67b67b Mon Sep 17 00:00:00 2001 From: Matt Barton Date: Fri, 29 Nov 2024 09:32:20 +0000 Subject: [PATCH 2/2] moved to docs folder --- {pathways => docs/pathways}/pathways-approach-proposal.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {pathways => docs/pathways}/pathways-approach-proposal.md (100%) diff --git a/pathways/pathways-approach-proposal.md b/docs/pathways/pathways-approach-proposal.md similarity index 100% rename from pathways/pathways-approach-proposal.md rename to docs/pathways/pathways-approach-proposal.md