bcgov / bcbb

A collection of modules for the Drupal base build used to streamline the build and deployment of applications at Ministry of Finance.
GNU General Public License v2.0
2 stars 0 forks source link

Content type for Documentation #18

Closed CraigClark closed 1 year ago

CraigClark commented 1 year ago

OP timer

https://openplus.monday.com/boards/4092908516/pulses/4614313836


TBD this is probably a base-build candidate. If so, how do we handle the content type? WxT has a 'book' content type that comes with it. We then use the same settings for project specific content that requires the book features.

User story

As a user of any BD Drupal application, I want to be able to access documentation that will help me understand how the system works for a person with my role so that I can learn how to work with the system to accomplish the tasks it is designed to do.

As a manager of an application, I want to create sets of documentation so that users of the system can easily find material relevant to how they work.

This feature support the following requirements

base-build

Additional context

This content type should use the book module. The book should support subway navigation for internal pages and an option to print the content of the entire book. See RSAMS for an example.

A table of contents for sections within a page will be added in #22.

Proposed solution

Estimated level of effort

Definition of done (DoD)

    • [x] Documentation is an index page with a table of contents of child pages at the bottom
    • [x] The table of contents at the bottom of the index page shows a summary if it is available
    • [x] The documentation has forward, home, and backward navigation
    • [x] People with correct permissions can add sub-pages directly from a page in the documentation
    • [x] There is a link to print all pages of the selected documentation
    • [x] The title of the index page appears in the breadcrumb
    • [x] A custom module exists bcbb_book that will enable book and create the content type

Testing

Automated functional tests

CraigClark commented 1 year ago

@lkmorlan don't worry about the subway nav if it's not included in the module. We can add it later, it's just CSS and we can write something that looks the same as WET but is more modern

lkmorlan commented 1 year ago

Examples: https://dv12.openplus.ca/en/node/242 https://dv12.openplus.ca/en/help

CraigClark commented 1 year ago

This works fine, but needs theming. Adding myself to work on that.