A collection of modules for the Drupal base build used to streamline the build and deployment of applications at Ministry of Finance.
License: GNU General Public License v2.0
![repo-mountie[bot] avatar](https://avatars.githubusercontent.com/in/19327?v=4 "repo-mountie[bot]")
OP timer
https://openplus.monday.com/boards/4092908516/pulses/4614188523
Most of the work for this task is being done as part of the data catalogue search feature.
This task is to confirm that the work done on the data catalogue makes it's way to the base build.
OP timer
We found an issue with a contributed module that is causing automated tests to fail. The issue was reported to the maintainer
This needs to be discussed at a base-build meeting.
The bootstrap_layouts module is used by page manager to provide the layout we are using for the search result page. This module is convenient because it has multiple BS5 layouts to choose from. You can also add custom classes to regions.
Making custom layouts is not a bug deal, it would get around the issue we have with tests failing. The down side of custom layouts is that they are typically done in code. So the options provided by bootstrap_layouts would not be available to site builders.
That being said, the inability to write automated tests is a serious issue, especially for a feature as important as search.
As a team, figure out if we want to stay with bootstrap_layouts. If now, what do we do instead?
Related:
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.
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 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.
bcbb_book that will enable book and create the content typeOP timer
https://openplus.monday.com/boards/4092908516/pulses/4589910164
Teams are encouraged to favour modern inclusive phrasing both in their communication as well as in any source checked into their repositories. You'll find a table at the end of this text with preferred phrasing to socialize with your team.
We're aligning our development community to favour inclusive phrasing for common technical expressions. There is a table below that outlines the phrases that are being retired along with the preferred alternatives.
During your team scrum, technical meetings, documentation, the code you write, etc. use the inclusive phrasing from the table below. That's it - it really is that easy.
For the curious mind, the Public Service Agency (PSA) has published a guide describing how Words Matter in our daily communication. Its an insightful read and a good reminder to be curious and open minded.
The word "master" is not inherently bad or non-inclusive. For example people get a masters degree; become a master of their craft; or master a skill. It's generally when the word "master" is used along side the word "slave" that it becomes non-inclusive.
Some teams choose to use the word main for the default branch of a repo as opposed to the more commonly used master branch. While it's not required or recommended, your team is empowered to do what works for them. If you do rename the master branch consider using main so that we have consistency among the repos within our organization.
| Non-Inclusive | Inclusive | |
|---|---|---|
| Whitelist | => | Allowlist |
| Blacklist | => | Denylist |
| Master / Slave | => | Leader / Follower; Primary / Standby; etc |
| Grandfathered | => | Legacy status |
| Sanity check | => | Quick check; Confidence check; etc |
| Dummy value | => | Placeholder value; Sample value; etc |
This list is not comprehensive. If you're aware of other outdated nomenclature please create an issue (PR preferred) with your suggestion.
Some time ago, the existence of an extended env variables module (coloured bar?) was discussed for addition to the BCBB but it was not ticketized. Creating a ticket now as a reminder in case that is something that the devs want to add to the bcbb to benefit future users.
OP timer
https://openplus.monday.com/boards/4092908516/pulses/4666686647
There is currently no way to add custom classes to blocks on a panels page. I had a discussion with Joel about this and ke provided the following info:
So, if you look at the PATCHES.txt file in panels on other sites you can see the patches that were applied... in this case the patch came from drupalwxt so it is not in our composer.json
Enter drupal/panels patch #2849867 description here
Source: https://www.drupal.org/files/issues/2020-04-30/panels_custom_attributes_in_panels_blocks-2849867-78.patch
might be worth getting Liam to add all patches to panels that DrupalWxT add.
OP timer
https://openplus.monday.com/boards/4092908516/pulses/6021661632
There is a feature we are using on the data dictionary in the data catalogue that expands and collapses a bunch of <details> elements.
Right now it is specific.
this should be made generic and be put into the base-build.
the idea is that an author would add a class, say details-toggle to a wrapper around a bunch of details elements and it just works.
The JS needed for this is already written https://github.com/bcgov/MFIN-Data-Catalogue/blob/1.0.x/html/themes/custom/dc_theme/js/mr.js
After this is done, do bcgov/MFIN-Data-Catalogue#356
OP timer
https://openplus.monday.com/boards/4092908516/pulses/4806164629
To be characterized at the base-build meeting
Depends on #14
Create a custom module named bcbb_search that:
search_apifacetssearch_index display modesearch_index displaysite_search/search/sitesearch_api to:
bcbb_search is enabled by default when a new site is createdsearch/siteNote: Important! once this works in base-build we need to make sure data catalogue is using it with data catalogue specific config done locally on that project.
https://openplus.monday.com/boards/4092908516/pulses/4994902277
Please see screenshot.
If a template isn't practical for the links, we need
<a href="/node/add/book?parent=38">Add child page</a>to be
<a class="btn btn-light" href="/node/add/book?parent=38"><i class="fa-solid fa-print"></i> Add child page</a>and
<a href="/node/add/book?parent=38">Add child page</a>should be
<a class="btn btn-success"> href="/node/add/book?parent=38">Add child page <i class="fa-solid fa-plus"></i></a>
Remove sidebar from home page of a book, these links are available at the bottom of the page.
Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).
In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means it's critical that we work to make our content as discoverable as possible. Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.
Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.
That's it, you're done!!!
Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.
If your org is not in the list below, or the table contains errors, please create an issue here.
While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.
Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.
If your application is live, add the production URL.
| Short Code | Organization Name |
|---|---|
| AEST | Advanced Education, Skills & Training |
| AGRI | Agriculture |
| ALC | Agriculture Land Commission |
| AG | Attorney General |
| MCF | Children & Family Development |
| CITZ | Citizens' Services |
| DBC | Destination BC |
| EMBC | Emergency Management BC |
| EAO | Environmental Assessment Office |
| EDUC | Education |
| EMPR | Energy, Mines & Petroleum Resources |
| ENV | Environment & Climate Change Strategy |
| FIN | Finance |
| FLNR | Forests, Lands, Natural Resource Operations & Rural Development |
| HLTH | Health |
| IRR | Indigenous Relations & Reconciliation |
| JEDC | Jobs, Economic Development & Competitiveness |
| LBR | Labour Policy & Legislation |
| LDB | BC Liquor Distribution Branch |
| MMHA | Mental Health & Addictions |
| MAH | Municipal Affairs & Housing |
| BCPC | Pension Corporation |
| PSA | Public Service Agency |
| PSSG | Public Safety and Solicitor General |
| SDPR | Social Development & Poverty Reduction |
| TCA | Tourism, Arts & Culture |
| TRAN | Transportation & Infrastructure |
NOTE See an error or omission? Please create an issue here to get it remedied.
OP timer
https://openplus.monday.com/boards/4092908516/pulses/5931744953
Add gin theme and gin_toolbar module to the base build. Explore whether gin theme would play nice on DC.
Note: placeholder, pending discussion of value of vbo by default for content overview page
OP timer
https://openplus.monday.com/boards/4092908516/pulses/4823722071
OP timer
https://openplus.monday.com/boards/4092908516/pulses/6732112688
Reset buttons should have class btn-danger instead of btn-primary
Here is an example from the search page
Here is an example from the report builder | dashboard > reports > report builder
OP timer
Allow the use of CSS classes icon-type, icon-before, and icon-after.
OP timer
https://openplus.monday.com/boards/4092908516/pulses/6459822055
Ensure devOps related documentation is written in a generic fashion (not app specific) and is universally accessible.
OP timer
Since Drupal is moving away from profiles, this cannot be enabled by default.
We need to make sure the theme looks correct no matter what settings are applied.
Try the various theme settings for the BB. Make sure they all look decent. Once that is done, for future projects, enable the theme and configure as needed.
OP timer
As discussed as part of #21 , install mamoto to base-build, enable on data catalog. Chris will investigate configuration.
OP timer
at /admin/config/search/path/settings, select setting to keep existing alias when a path changes.
/admin/config/search/path/settingsAgenda
include DSS dev team and OpenPlus
OP timer
In early stages of development we were using bootstrap_layouts module for the layout of the search page. Something in the module was causing automated tests to fail. After a day and a half or so of investigation, it was determined that the most efficient approach would be to add a custom layout module.
Create custom layouts that can be used by the base-build.
OP timer
https://openplus.monday.com/boards/4092908516/pulses/5007668210
Related base-build theme issue
Most people will be authenticating on the site using their IDIR accounts. Currently, there are tabs at /user/login for login and resetting passwords. These options are not useful to people logging in with IDIR and should be removed. If people need to reset passwords, they change their Microsoft credentials, not Drupal. The change password option is misleading.
The page is called Login, the tab is called Login and the CTA on the link is titled Login. The tab is redundant and should be removed.
Administrators will continue to login using Drupal accounts at /user/login?showcore. For these users, the tabs should remain as they are.
NOTE: If it proves difficult to manage tabs on the same URL, not showing the tabs takes priority over showing them. Admins have other ways to recover passwords if needed.
/user/login, I see no login or password tab/user/login?showcore I see typical Drupal login tabsOP timer
https://openplus.monday.com/boards/4092908516/pulses/4967667339
This change should be available in the base-build but needs to be implemented on the data catalogue.
If needed, the base-build theme is here https://github.com/bcgov/bcbb-theme
Note: The search block should not appear in the header on the search page (
/search/site)
OP timer
https://openplus.monday.com/boards/4092908516/pulses/4950485273
This is for use on #18
[toc] will create a table of contents of that page using its headingsbcbb_book module.OP timer
https://openplus.monday.com/boards/4092908516/pulses/4614127927
These are already in the data-catalogue. They should use the modules from base-build instead.
If I've missed any modules, please add them and post a comment about it.
Add the modules required for creating panel pages.
OP timer
As a business owner of a Drupal-based application
I need to have access to basic site analytics
so that I can assess the use of the site on demand.
Application owners are looking for:
Analysis of options, ideally native to Drupal, that can support these types of analytics. Timeline for advice and discussion: mid-August 2023
Timer
https://openplus.monday.com/boards/4092908516/pulses/5860518150
Add smtp to base-build, enable on DC and build.
Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.
It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.
I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)
OP timer
As a product manager at MFIN, I want to be able to understand the deployment of a search feature to any Drupal project so that users can be confident they have accurate results and overhead is minimal for the development team.
Document configuration, with screenshots. Cover the following
Note: All documentation in the wiki are considered living documents and will be changed as needed after this task has been completed.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.