Manual test scenarios generated from tracked changes. Pass/Fail and Notes are filled in by a tester while actually running each test.
| Test | Source | Precondition | Steps | Expected Result | Pass/Fail | Notes |
|---|---|---|---|---|---|---|
| Build a product's hub with a custom introduction | capstone-platform#2 CIP-2 | Access to the Config page for a product other than Retail POS that has help articles. Note whether the product already has Release Notes and QA Test Scenarios pages. |
| The hub shows the introduction you entered, a Platform output section that links the product's Release Notes and QA Test Scenarios pages (where those pages exist), and a Documentation section listing the product's help articles. The Help hub introduction box does not accept more than 600 characters. | ||
| Hub uses the default introduction when the box is blank, and titles with special characters show exactly | capstone-platform#2 CIP-2 | A product other than Retail POS whose Help hub introduction is empty, with at least one help article whose title contains & or <. |
| The introduction reads: "Release notes, help articles and QA scenarios for <product name>, drafted by the Change Intelligence Platform from the product's changes and reviewed by a person before they are published." with the product's name filled in. The article title appears exactly as written, including the & or < characters. | ||
| Retail POS demo hub is unchanged | capstone-platform#2 CIP-2 | Note how the Retail POS hub looks before the change ships. |
| The Retail POS demo hub looks the same as before. | ||
| Default product is marked, must stay active, and the dashboard opens on it | capstone-platform#2 CIP-2 | At least two active products exist; Retail POS is the default. |
| Retail POS is marked (default product). Making it inactive is refused, and the Config page explains: "This is the default product, which the dashboard opens on, so it must stay active." The dashboard opens on Retail POS until another product is picked in the Product picker, after which it shows the picked product. | ||
| Command run without –department falls back to the default product | capstone-platform#2 CIP-2 | Ability to run platform commands; more than one product is active and Retail POS is the default. |
| The command uses Retail POS and says: "No product named: using the default product, retail-pos (pass –department <slug> for another)." If only one product is active, the command uses that product instead. | ||
| Config form shows three sections with a connection picker for each kind | capstone-platform#3 CIP-3 | Signed in with access to the Config page. At least one GitHub, one Atlassian and one WordPress connection exist, ideally including one failing connection, and for one kind only a single connection exists. |
| The form has three sections: Product (Name, Slug, Active), Where changes come from (GitHub connection and repositories, Atlassian connection and Jira project key) and Where output goes (the four output switches and what they need). Each picker lists only connections of its own kind. A failing connection is marked "(failing)". For a kind with only one connection, the new product starts with that connection already selected. | ||
| Fields appear only while the outputs that need them are on | capstone-platform#3 CIP-3 | Signed in and editing a product on the Config page. |
| Confluence space key is shown only while Internal release notes is on, and when it reappears it still holds the value entered earlier. WordPress connection, WordPress hub page title and Help hub introduction (optional) are shown only while an output that publishes to WordPress is on. | ||
| All problems are listed under Before you can save and Save changes stays disabled | capstone-platform#3 CIP-3 | Signed in. An existing product has Internal release notes and Customer release notes switched on. Another product (for example Retail POS (demo)) already owns a repository such as acme/shared. |
| Problems appear together under Before you can save before anything is saved, for example "Customer release notes needs Internal release notes switched on.", "Enter the Confluence space key: an output that is switched on publishes there." and "acme/shared already belongs to Retail POS (demo). A repository can belong to only one product." Save changes stays disabled until no problems remain, and nothing is saved while it is disabled. | ||
| Read-only view wording for repositories and an empty help hub | capstone-platform#3 CIP-3 | A product with one repository tracked by release and one repository with hand-picked pull requests. A help hub that has no articles yet. |
| The repository tracked by release says "tracked by release" instead of "0 PRs", and the other says "N hand-picked pull requests" with its count. The empty help hub says "Articles appear here as the platform publishes them." | ||
| Choose Jira project and Confluence space from live dropdowns | capstone-platform#4 CIP-4 | A product exists with a working Atlassian connection that can see at least one Jira project and one Confluence space. The tester can open the Config page. |
| Both dropdowns list the projects and spaces the Atlassian connection can see, each shown as "KEY: Name" (for example "CIP: Change Intelligence Platform"). Typing filters the list, and the chosen entry is held in the field. If a key that the connection cannot see was saved earlier, it still appears as a choice, marked "(this connection cannot see it)". | ||
| Choose WordPress hub page or name a new one | capstone-platform#4 CIP-4 | A product exists with a working WordPress connection to a site that has published top-level pages. |
| The dropdown lists the site's published top-level pages plus "A new page…". Selecting "A new page…" asks for a "New hub page title". | ||
| Choose GitHub repositories and add one by its address | capstone-platform#4 CIP-4 | A product exists with a working GitHub connection that can read at least one repository. The tester knows the address of one repository the connection can read and one owner/name that it cannot read or that does not exist. |
| The repositories list holds the repositories the GitHub connection can read. The readable address is checked against GitHub and the page says "Added owner/name." The unreadable entry is refused with a reason such as "GitHub has no repository owner/name that this connection can read." Hand-picked pull requests, priority and stack appear under the Advanced section. A line there for a repository that is not chosen is listed under "Before you can save". "Refresh lists" reads the lists again. | ||
| Field falls back to typing when a list cannot be read | capstone-platform#4 CIP-4 | A product whose Atlassian connection cannot read the project list, for example because its credentials are invalid so that Jira answers with HTTP 401. |
| The Jira project field is a box to type in, with a note explaining why, for example "Type the Jira project key: the list could not be read. Jira answered with HTTP 401." | ||
| Product with no GitHub repository shows the not-set-up box | capstone-platform#5 CIP-5 | A product exists that has no GitHub repository chosen. The tester can select this product in the sidebar. |
| On Generate, Review and Publish, only a box headed "<product> is not set up yet" is shown (instead of a disabled "Generate drafts for 0 changes" button, a one-line Review page, or "Switched off" tiles). The box lists what is missing and what to do, e.g. "No GitHub repository is chosen. Choose its repositories under Where changes come from." Clicking Open Config opens the settings of the product chosen in the sidebar. | ||
| Product with every output switched off shows the not-set-up box | capstone-platform#5 CIP-5 | A product exists that has a GitHub repository chosen but every output switched off. |
| Each page shows only the "<product> is not set up yet" box, listing that the outputs are switched off and what to do about it. | ||
| Product with a failing connection shows the needs-attention box above the normal page | capstone-platform#5 CIP-5 | A product that is otherwise set up, where the GitHub connection is failing its check, and some drafts exist to review. |
| A box headed "<product> needs attention" appears above the normal page content, with a message such as "The GitHub connection is failing its check. Open it on the Connections page and check it." Drafts can still be reviewed underneath. An Open Connections button is shown and takes the tester to the Connections page. | ||
| Fully set-up product sees pages unchanged, and picker info icons explain shared lists | capstone-platform#5 CIP-5 | A product that is fully set up with working connections. |
| No setup or attention box appears; the pages look exactly as before. The info icons say the list holds everything the Atlassian connection can see, including projects and spaces other products use, and that choosing one changes only this product. | ||
| Connections page shows every connection as stored with full controls | capstone-platform#7 CIP-7 | The updated app is deployed and rebooted. The connections Retail POS Demo (GitHub), CIP and KAN Atlassian, and Demo Publishing Site WordPress have been added on the Connections page. |
| No connection named "(deployment default)" is listed, and no "Deployment secrets" label appears. Every connection is shown as "Stored, encrypted" and offers both Replace credentials and Delete connection, whatever its kind (GitHub, Atlassian, WordPress). | ||
| Products work end to end through the added connections | capstone-platform#7 CIP-7 | The updated app is deployed. Retail POS (demo) and Change Intelligence Platform are pointed on Config at the connections added on the Connections page. |
| Each connection passes Check connection. Sync, Generate and Publish all succeed for both products using the added connections. | ||
| Product with no chosen connection starts on the oldest connection of the right kind | capstone-platform#7 CIP-7 | At least two connections of the same kind exist on the Connections page, and you know which one was added first. A product has no connection chosen for a job that uses that kind. |
| The job starts on the oldest connection of the right kind. | ||
| Annotated screenshots appear under steps in the five updated help articles | capstone-platform#9 CIP-9 | The screenshots have been placed in the live help articles. Open the published help site on a desktop browser. |
| Each article shows screenshots placed right after the steps they belong to. The screenshots are in the platform's teal style with stamps, boxes, arrows and cursors. The images look sharp, are indented under their step, and are never wider than the text column. The old low-resolution images are gone, and the article text is otherwise unchanged. "Publishing Approved Drafts" shows only a screenshot for the sidebar step. | ||
| Help article with screenshots displays without sideways scrolling on a phone-width screen | capstone-platform#9 CIP-9 | Use a phone, or a browser window narrowed to 375 pixels wide. |
| The article shows its 7 screenshots. All of them fit within the text column, and the page does not scroll sideways. | ||
| Articles left out of the update keep their existing content | capstone-platform#9 CIP-9 | Open the published help site on a desktop browser. |
| "Finding Your Way Around" still shows its existing screenshot, not a new captured one. "Setting Up a Product" has not received new step screenshots as part of this change. | ||
| Sidebar pipeline items are unnumbered and joined by a line | capstone-platform#10 CIP-14 | The app has been restarted after the update and the dashboard is open. |
| The sidebar items read Generate, Review and Publish, with no numbers. A thin line runs through their icons, joining them and showing the order. Release candidate sits beside the line, under Generate. The current step stays highlighted as you move between pages, and each page title matches its sidebar label with no number. | ||
| Sync sources box is headed 'Settings for' with the product name set apart | capstone-platform#10 CIP-14 | At least one product is set up. The app has been restarted after the update. |
| The box is headed Settings for, followed by the product's name. The name is shown in its own color and case, so it is clearly separate from the heading and does not read as part of the same phrase. | ||
| Ingest a release uses the 'Release cut name' label | capstone-platform#10 CIP-14 | The app has been restarted after the update. |
| The field is labeled Release cut name. The old label, Name of this cut, no longer appears. | ||
| Disabled Delete connection explains what to do | capstone-platform#10 CIP-14 | A connection exists that is used by at least one product. |
| Delete connection is disabled and shows this explanation: "To delete it, open Config, choose a different connection for each of those products, then come back here." | ||
| Screenshot check reports problems in the current help articles | capstone-platform#11 CIP-15 | A checkout of the tool containing this change. The five live help articles are in their state before the rewrite, and the help/placements.json file is present. |
| The command reports problems for each live article. These cover steps with no screenshot, lettered lists without a lettered screenshot or with letters on the wrong parts, screenshots that mark something their step doesn't name, and step numbers on images that sit under their own step. In total, 43 problems are listed. The command only reports and does not change any files. | ||
| Finding Your Way Around shows the lettered sidebar screenshot | capstone-platform#12 CIP-16 | Access to the platform's published help pages in WordPress. |
| The sidebar screenshot uses A–F letter labels, not the old numbered labels. | ||
| Bringing in Changes and Generating Drafts follow the new layout | capstone-platform#12 CIP-16 | Access to the platform's published help pages in WordPress. |
| Bringing in Changes has a screenshot under every step, lettered sections, and lettered labels on the Release candidate page screenshot. Generating Drafts shows concepts as bullets, a screenshot per step, and the "why two release notes" panel. | ||
| Connecting Your Tools shows the lettered card, per-step screenshots and delete callout | capstone-platform#12 CIP-16 | Access to the platform's published help pages in WordPress. |
| The connection card is labeled with letters, every step of adding a connection has a screenshot, and a callout about deleting a connection is present. | ||
| Lettered option lists stay as one continuous list | capstone-platform#12 CIP-16 | Access to the four republished help pages in WordPress. |
| Each set of lettered options appears as one continuous A, B, C list, without restarting the lettering partway through. | ||
| Letter stamps are larger with a soft shadow in live help articles | capstone-platform#13 CIP-17 | Access to the four live help articles that were re-captured and republished (pages 249, 252, 253, 261). |
| Stamps are a few pixels taller than the heading's capital letters beside them. Each stamp carries a soft drop shadow, and the shadow is not cut off by the edge of the screenshot. | ||
| Sync sources screenshot has no overlapping boxes | capstone-platform#13 CIP-17 | Access to the live help article that contains the Sync sources screenshot. |
| On the Sync sources screenshot, the Settings for panel is boxed, and an arrow points at its Change these on the Config page link. No box overlaps another, and a gap remains between neighboring boxes in all four articles. | ||
| Capture refuses marks too close to box, and the screenshot check uses the help manifest | capstone-platform#13 CIP-17 | Ability to run the screenshot capture tool and screenshot-check. You also need a shot that marks two elements with boxes that sit too close together to box both. |
| The capture fails with a message naming both marks, and no image is saved for that shot. screenshot-check reads help/articles.json and reports all four articles OK. | ||
| Review card shows existing and missing screenshots | capstone-platform#14 CIP-18 | A documentation draft is open for review in the dashboard. It contains Screenshot lines under its steps: at least one names a screenshot that already exists in the published articles, and at least one names a new screenshot that has not been captured yet. |
| The existing screenshot appears as its actual image. The missing one appears as a dashed "Screenshot needed" box showing its name. The chip shows how many screenshots are still to capture. The card says the draft can be approved now and is published once every screenshot exists. | ||
| Publish to WordPress waits for missing screenshots | capstone-platform#14 CIP-18 | Two approved documentation drafts: one with at least one missing screenshot, and one where every screenshot exists. Access to the WordPress help site to check the result. |
| The draft with a missing screenshot stays unpublished, nothing is changed in WordPress, and the message says why, naming which screenshots are missing. The draft with all screenshots is published with its images placed. | ||
| publish-help refuses to overwrite a page edited in WordPress | capstone-platform#14 CIP-18 | Access to run the publish-help tool against the live help pages. One live help page has been edited directly in WordPress since publish-help last published it. |
| Before writing, publish-help backs up each live page into help/backups. It refuses to replace the page that was edited in WordPress since it last published it. When run with –replace-edited for that page, it replaces the page. | ||
| Publish page describes the product's own destinations | capstone-platform#15 CIP-13 | At least one product with internal publishing to Confluence (a known space key) and customer publishing to a WordPress hub (a known hub title) switched on. The tester can open that product's Publish page. |
| The release-name label no longer says "(the Confluence page title)". The cards no longer say "the WordPress hub" or "the QA Test Scenarios table on the WordPress hub". Each card shows one short line per destination, built from the product's own settings, for example "Internal: Confluence, space <space key>" and "Customers: WordPress, under <hub title>", using that product's actual space key and hub title. The second product's page shows its own destinations. | ||
| Switched-off channel is neither described nor named | capstone-platform#15 CIP-13 | A product with one publishing channel switched off, for example customer publishing to WordPress off while internal publishing to Confluence is on. The page is viewed in read-only mode. |
| No card line describes the switched-off channel. The read-only notice names only the tools that are in use, so the tool for the switched-off channel (WordPress in this example) is not mentioned. | ||
| Card buttons stay on one line at wide widths | capstone-platform#15 CIP-13 | A product whose hub title is long enough to wrap onto more than one line in its card. A browser window that can be resized. |
| At both widths, the three buttons stay on one line and line up across cards, even where the hub title wraps. The page has no sideways scroll. |