bcgov / bcgov/nr-bcap

Help Text & Training (Inventory): Enable & populate Help Button text for each Card in an Inventory-related Resource Model

Open
#775 2 comments 0 reactions 3 assignees Claimed by @crlake View on GitHub
*MVP 1 Documentation INV Task
Dominant language
Python
Stars
1
Forks
1
Avg merge
2d 20h
Merged PRs (30d)
13

Description

BLOCKS / BLOCKED BY: #472

TICKET ORIGIN (PERSON / EVENT): Necessary branch-side work required to complete help text (#472). Ticket created to separate it from dev work.

RELATED BIZ REQ(s): NFR23 - BCAP must allow documentation including training material to be available to internal government staff. Online help for external users.
RELATED TICKET(s): #472, #139

ISSUE DESCRIPTION / CONTEXT:

There is currently an out-of-the-box Help button that can be enabled on individual screens via the **"Arches Designer" icon** (looks like a bookmark) in the side menu on the far left of Arches. From here, choose **"Resource Models"** > **select the model the page is in** (e.g. Archaeological Site") > **select the page** to add/edit help for (e.g. "Identification and Registration") > Click the **"Cards" tab** > under the "Card Configuration" section,  toggle **"Enable Card-level help" and populate the section** to help people navigate the page.

These help buttons apply to the whole screen ("card") instead of being available for each section or field individually ("widgets" etc.)

Image

**NOTE: BECAUSE CARDS ARE PART OF RESOURCE MODELS, WE NEED TO COORDINATE HELP TEXT CHANGES WITH DEV.** Any changes we make in there are saved as part of the resource model, and if we are both making changes it will be very difficult to merge them later. **What we have done with the other applications is scheduled a time that we (the devs) won't make any changes and then the business can add their help text.** Dev then needs to export the resource models and include those in the source code so they are included next time we do a refresh.

Help text wil be written by inventory and saved to a document until we are ready to paste them in. That document will be used to start a user manual, so should contain all help text we put into BCAP.

**Help text document stored here:** **BCAP Shared Team Files\Training\Inventory Functions**

USER STORIES:

Given a help button opportunity exists for every Card (screen) in BCAP
When a screen is formatted as a Card
Then this help button should be enabled for the card, and text should be populated by the SMEs

ACCEPTANCE CRITERIA:

Inventory has populated help text for cards in the Resource Models that apply to Inventory work:

[ ] Archaeological Site
[ ] Archaeological Site Submission
[ ] Site Visit
[ ] Contributor
[ ] Repository
[ ] Legislative Act

NEXT STEPS: Inventory and Maria to test saving help entries and edits.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.