az-digital / az_quickstart Goto Github PK

Motivation

It was noticed in #42 that the existing eslintrc file in use by Drupal core that provides our lint settings is rather geared towards ES6 and transpiled ES5, rather than standard ES5. This lead to the realization that Drupal core's process for how they develop javascript has changed in Drupal 8/9:

• Developers edit and work with *.es6.js files
• Development environment uses yarn and babel to transpile the es6.js files to .js files, which are what is actually used by the Drupal theme infrastructure
• .js files are not intended to be editable by humans
• transpiled .js files are a committed part of the codebase; they are not transpiled on the fly during site operation.

More information:
https://www.drupal.org/node/2815083

As documented at https://confluence.arizona.edu/pages/viewpage.action?pageId=105505925 we elected that it would be good to follow this same path, and that we should update our tooling to allow for usage of this process. Going forward, this means we would write our javascript in es6, and allow babel to create the browser-usable versions.

A good first step in that regard would be to update our Lando and DDEV workflows to allow for yarn to be installed and have tooling to run a babel transpile process on our install profile's future .es6.js files.

Please see Drupal core's core/package.json for necessary dependencies.

Is your feature request related to a problem? Please describe.

It's currently difficult to write ES5 javascript code that passes the drupal core eslint settings.

Proposed Resolution

Describe the solution you'd like

Yarn tooling integrated into Lando/DDEV set up with scripts to transpile .es6.js files. It would also be nice if there was "watch" functionality to transpile whenever files change. It's possible that lack of true inotify support in VMs may complicate watch functionality - TBD.

Describe alternatives you've considered

Available alternatives:

• Continue to write ES5 javascript with a custom eslintrc.json to avoid problematic eslint sniffs that are difficult to avoid in readable ES5.

Additional context

This avenue was chosen due to desiring to follow core-friendly workflows, and the knowledge that ES6 will gradually become the browser standard as time goes on.

Motivation

For D7, @kevcooper added some basic functionality to uaqs_mail to add specific information to mail headers (related to Pantheon site information and SES configuration set and message tags) (see http://jira.arizona.edu/browse/UADIGITAL-2223).

Is your feature request related to a problem? Please describe.

Proposed Resolution

We'd like to have the ability to do this in D8 as well.

Describe the solution you'd like

@kevcooper Also suggested we could expose some site configuration settings that would allow site owners to pick and choose which information to attach to outbound messages. @tadean suggested that some more generic information such as the Drupal site name could also be useful.

Describe alternatives you've considered

Additional context

What is the problem that we want to solve?

The contrib Display Suite module was added as a dependency as part of #38 and #39. We need to decide whether we want to keep the module as a dependency long term or not.

Display Suite was used for #39 primarily because @akslay preferred the more minimal markup of the Display Suite provided layout plugin templates over the layout plugin templates provided by core out of the box. It should be possible to create our own layout plugins and templates with whatever markup we want as a replacement if none of the other features provided by the module are needed/used.

As is, the module has added stub configuration to the third_party_settings of various other exported configuration entities including entity_view_display settings which we probably don't want to have to maintain if not really needed (example third party settings). We should determine if any of the exported Display Suite third party settings are actually needed/being used for anything.

Conditions of satisfaction

• The considered options are documented
• A recommended next step is documented
• An estimate of time and effort is provided for the recommendation
• …

Describe the bug
The probo check for Drupal 8 Coding Standards has two errors and one warning

7FILE: ...tart-scaffolding/web/profiles/custom/az_quickstart/COPYRIGHT.txt
8----------------------------------------------------------------------
9FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
10----------------------------------------------------------------------
11 1 | WARNING | Line exceeds 80 characters; contains 114 characters
...
15FILE: ...rt-scaffolding/web/profiles/custom/az_quickstart/CONTRIBUTING.md
16----------------------------------------------------------------------
17FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
18----------------------------------------------------------------------
19 36 | WARNING | [ ] Line exceeds 80 characters; contains 94
20    |         |     characters
21 84 | ERROR   | [x] Expected 1 newline at end of file; 0 found
22----------------------------------------------------------------------
23PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY

https://app.probo.ci/#/dashboard/build/a98bdae6-a28e-4467-8aec-a30fa6d74c14/task/5c1139dfff400001

To Reproduce
Steps to reproduce the behavior:

1. Submit a pull request
2. Look at the "checks" section
3. View details on Drupal 8 Coding Standards
4. See error outlined in probo (ex: https://app.probo.ci/#/dashboard/build/a98bdae6-a28e-4467-8aec-a30fa6d74c14/task/5c1139dfff400001) if you're able to login and all that : )

Expected behavior
Drupal 8 Coding Standards only fail if the pull request introduces non-standard code

Screenshots

Create new content editor role

Do not disclose security vulnerabilities here, please email us instead:
[email protected]

Is your feature request related to a problem? Please describe.

Currently, there are only local development instructions for Lando; however, there's a known issue for Lando and Pantheon, which doesn't allow a user to access information for a given Pantheon site, so providing an alternative local development process is necessary for Pantheon users who might also want to contribute to Quickstart.

Describe the solution you'd like

Add basic instructions for creating a local working copy of a Quickstart site using DDEV.

Describe alternatives you've considered

There are already instructions for Lando, but as listed above, Lando has some limitations when used with Pantheon sites and some users prefer DDEV to Lando, so offering an alternative is useful.

Additional context

N/A

name: Feature request
about: Add az_cas module to override default CAS settings unique to the University of Arizona.
labels: 'enhancement'
assignees: 'trackleft'

Motivation

As an affiliate of the University of Arizona I would like to be able to log into an az_quickstart site via the centralized authentication system.

Is your feature request related to a problem? Please describe.

No

Describe the solution you'd like

CAS module installs and az_cas module overrides the initial settings.

Motivation

As of version 8.x-1.0-beta1, the Layout Builder Styles module does not provide a way to control the order which layout builder styles are listed on the Layout Builder interface.

Is your feature request related to a problem? Please describe.

When adding a block to a page with Layout Builder, the layout builder styles are presented in a seemingly random order.

Proposed Resolution

Describe the solution you'd like

A patch has been uploaded to drupal.org by one of the module maintainers that adds weight to layout builder styles allowing manual ordering. We should try this patch and if it works, update our exported layout builder styles to include weights.

Describe alternatives you've considered

@akslay and @joeparsons worked on a much simpler patch that would have just applied an alphabetical order to the layout builder styles but the patch now available from the module maintainer looks more promising.

What is the problem that we want to solve?

We need to be able to run D8 Javascript Functional Tests both locally and on our CI tools.

We should look into what Drupal.org is doing for this and also at what tools are already installed/available on ProboCI's docker images.

UC Davis' SiteFarm project has Functional Javascript tests and they use ProboCI.

Conditions of satisfaction

• Test dependencies are documented
• Lando/ddev support is considered

User Story(s)

As a Quickstart site administrator, I'd like to have default roles with sensible permissions already configured when I create a new Quickstart site.

As a site administrator, I would like to be able to change permissions associated with roles without worrying about losing my changes on code updates.

As a Quickstart developer I would like to be able to add new features and assign roles and permissions for new installations of Quickstart, as well as provide defaults for when said feature is enabled.

Conditions of satisfaction

• Default roles should be provided
• Default permissions should be provided
• Default permissions are override-able after installation.
• Default permissions for modules that are yet to be enabled will be set once enabled.
• New features can be added with default permissions.
• Additional roles can be added other than the defaults after installation.

Out of scope, but related (Could be a spike).

• How to apply upstream changes to permissions if default permissions are overridden.
• How to apply upstream changes to permissions if default permissions are not overridden.

Open questions

User focused documentation will be needed following any decisions made.

What is the problem that we want to solve?

Our dev and test dependencies are currently defined and configured primarily in our az-quickstart-scaffolding repo.

As we've continued to work more on Quickstart, we've found that:

• We frequently need to make pull-requests on both the scaffold and profile repos at the same time to make changes to any of our dev/testing tools.
• Keeping various dependencies "in sync" between our scaffold and profile repos is becoming increasingly burdensome. This is particularly true for dependencies that are tied to specific versions of Drupal core such as drupal/core-dev-pinned and drupal/core-composer-scaffold.

Proposed resolution

Investigate and experiment with making our scaffolding repo as minimal as possible by moving dependencies from the scaffold repo to the profile repo.

A potential blocker that was brought up by @tadean was that the zaporylie/composer-drupal-optimizations composer plugin we are currently using has to be defined/configured in the "root" composer project to function correctly. This may also be true for drupal/core-composer-scaffold.

@tadean and @joeparsons discussed some potential changes/workarounds that would be worth experimenting with:

• Keep composer.json configuration for drupal/core-composer-scaffold in scaffold repo but experiment with moving actual dependency to profile repo
• (Or) use less specific version constraint for drupal/core-composer-scaffold in the scaffolding repo's composer.json and let it select the version defined by the profile automatically
• zaporylie/composer-drupal-optimizations helps a lot, but it wouldn't be the end of the world to not have it. (And maybe we could implement something with a similar in the profile to what it's doing - it's basically just composer trickery that truncates symfony packages.)

Conditions of satisfaction

• The considered options are documented
• A recommended next step is documented
• An estimate of time and effort is provided for the recommendation

Motivation

We need to capture @akslay's really cool layout builder work in a prototype module (or multiple modules).

Proposed Resolution

Export config from @akslay's development site on Pantheon

We need to create a Pantheon upstream that can be used for basic AZ Quickstart sites on the Pantheon platform.

Pantheon is working on a new platform feature that will support composer dependency installation on the platform without needing to use external build/CI tools which should be suitable for sites needing to add their own composer dependencies but there will still be a certain number of sites that can be managed using Pantheon's traditional upstream repository model that we want to maintain an artifact repository for.

Conditions of satisfaction

• Should create a Pantheon-specific source repository similar to the az-digital/az-quickstart-scaffolding repo that contains the composer.json and other files needed to create a build artifact suitable for deployment on Pantheon's platform
• Should create an artifact repository which will contain the actual artifact generated from building the Pantheon-specific source repository
• Should have a tooling established which provides a way for maintainers to trigger a pipeline on the source repository that builds an artifact and syncs any changes made to the main az-digital/az_quickstart repository into the Pantheon upstream repository

Maintain current functionality... or use the User as the Person in the future.

Problem/Motivation

The Layout Plugins provided by display suite do not seem to function properly with Layout Builder Drag and Drop functionality.

Describe the bug

When a layout builder section is created from one of the layout plugins provided by display suite, it doesn't seem possible to drag and drop blocks within the section. This is also present in a fresh non-quickstart Drupal site using nothing but layout builder and the latest display suite.

To Reproduce

Steps to reproduce the behavior:

1. Create a page
2. Click Layout
3. Click Add Section
4. Choose a section type that uses a DS Layout, eg. One column layout
5. Add several blocks to the section
6. Attempt to drag and drop block within the section to reorder them

Proposed resolution

It seems like this may be caused by missing markup that Layout Builder is expecting. Add potential patch to fix missing markup, or potentially switch to other Layout plugins (#45 ) that do not have the issue (custom plugins, bootstrap_layouts, etc)

Expected behavior

Blocks should be able to be reordered within a section via drag and drop.

Screenshots

Note that the DS Layout Plugin is missing the hashed outline that is present from the standard layout plugins. It seems like some markup may be missing.

Describe the bug
The PR template we added in #10 doesn't seem to be working. This appears to be because the file we added is named PULL_REQUEST_TEMPLATE.md instead of pull_request_template.md.

To Reproduce
Steps to reproduce the behavior:

1. Create a new PR
2. No template is applied

According to GitHub's docs, the template should be called .github/PULL_REQUEST_TEMPLATE/pull_request_template.md, not .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md.

Do not disclose security vulnerabilities here, please email us instead:
[email protected]

Motivation

Someone who hasn't drank enough coffee ☕️(like me this morning) might not connect "how to contribute" with "how to build locally." So this quick readme update aims to tease all the great info on that apge

Use [email protected] instead of [email protected] for security reports.

As part of PR #21 we added three new issue types.
task
spike
user story

We should add task as one of the pull request types. Also we should add spike and user story as other ways to contribute

Problem/Motivation

The Layout Builder Revision UI doesn't currently function correctly. It's not possible to write a revision message or disable the creation of revisions due to the form elements not being used. This is necessary for future work on review workflow.

Describe the bug

The form elements for the above functions need to be added to the Layout Builder form so that they're available to the user. The backend functionality for these already exists as part of the entity system.

To Reproduce

Steps to reproduce the behavior:

1. Edit the layout for a flexible page
2. Scroll to the bottom of the layout window, see that the revision text area is absent.

Proposed resolution

Drupal.org issue provides a patch for this functionality - investigate adding this to Quickstart.

Expected behavior

It should be possible to add a revision message, and enable or disable a revision being created.

Motivation

Core and contrib dependencies can now be specified with drupal.org project namespaces in .info.yml files. This is now recommended by Drupal.org.

Proposed Resolution

Describe the solution you'd like

Add project namespaces to dependencies in .info.yml files as documented on Drupal.org:
https://www.drupal.org/docs/8/creating-custom-modules/let-drupal-8-know-about-your-module-with-an-infoyml-file
https://www.drupal.org/node/2299747

Additional context

Only references to core and contrib projects hosted on drupal.org should be updated. Our own custom modules can continue to be referenced in the non-namespaced way.

Do not disclose security vulnerabilities here, please email us instead:
[email protected]

Is your feature request related to a problem? Please describe.
The current issue types of Feature Request and Bug Report aren't suitable for all tasks.

Describe the solution you'd like
Add issue templates for User Story, Task, and Spike to match our workflow from JIRA.

What is the problem that we want to solve?

The anonymous review feature of UA Quickstart (D7) has seen a large increase in usage across many Quickstart sites over the last couple of weeks. We need to make sure that the way we're implementing flexible pages for Quickstart 2.0 (blocks, layout builder, etc) won't prevent us from being able to support the same functionality going forward.

Conditions of satisfaction

• The considered options are documented
• A recommended next step is documented
• An estimate of time and effort is provided for the recommendation

GitHub currently recognizes az_quickstart as a CSS project and doesn't correctly recognize various vendor/generated files as such.

We can improve this by adding some rules to a .gitattributes file as documented here:
https://github.com/github/linguist#overrides

Conditions of satisfaction

• GitHub recognizes az_quickstart as a PHP project
• GitHub recognizes library files as vendor files
• GitHub recognizes minified CSS/JS files as generated files

Getting issues from all over the place without any proposed resolution is almost counterproductive and can add friction where there doesn't need to be.

Describe the solution you'd like

Add "Proposed Resolution" to feature request and bug_report issue templates

Describe alternatives you've considered

"Describe the solution you'd like" sounds more condescending and dismissive.

Additional context

Currently the feature request issue template has "Describe the solution you'd like" as part of it.

Motivation

We would like to encourage people to author and run tests locally before making a PR, plus would like to document things with less friction, setup time.

Is your feature request related to a problem? Please describe.

Currently every time I want to run a phpunit test, I have to set
export SIMPLETEST_BASE_URL="http://localhost"
export SIMPLETEST_DB="mysql://drupal8:drupal8@database/drupal8"

Proposed Resolution

Describe the solution you'd like

Add simpletest environment variables to lando config, and other local dev config files.

Do not disclose security vulnerabilities here, please email us instead:
[email protected]

Conditions of satisfaction

• replace current description: "Work that doesn't require a pull request."

What is the problem that we want to solve?

We need to figure out what's needed to be able to start tagging Quickstart releases:

• Pipeline(s) for updating version numbers in composer.json files (potentially cross-repo)
• Workflow
• Etc

Conditions of satisfaction

• The considered options are documented
• A recommended next step is documented
• An estimate of time and effort is provided for the recommendation

Motivation

During planning of our MVP for usage of Layout Builder, we have identified a few workflow customizations we would like to implement. It would be desirable if we could gather these customizations to LayoutBuilder workflows inside one of our custom modules related to Layout.

Proposed Resolution

It's recently become possible in Drupal 8.8.0 to override the LayoutBuilder class in use, and it might be useful to implement a LayoutBuilder subclass that can be used to hold these customizations, to go along with the new changes in #38

Some initial targets for this might consist as follows:

• Responsive Sidebar/Modal sidebar (to make working with large block forms feasible)
• Remove the "Add a custom block" secondary step and proceed directly to choosing the block type.
• Ability to add needed layout css/js.

Describe the bug
Our composer.json file references http://uadigital.arizona.edu.

Expected behavior
We should reference https://digital.arizona.edu instead.

Progress on this Epic is hinging on our decision on the best way to move forward with delivering a Flexible Page Content Type.

The options are:

• Layout Builder
• Gutenburg Editor
• Paragraphs

This is our process and timeline to make the decision:

1. Further define problems we are trying to address. Shoshana is taking the lead on this and will be presenting her findings based on the Content Editor surveys at the workshop on Wednesday, August 12th.
   
2. Create working prototypes in both Layout Builder and Gutenburg that would be complete and available by the end of that workshop on August 12th.
   
3. Test solutions with content editors. August 13th - 18th. Shoshana is taking the lead on this and will be presenting her findings at the workshop on Wednesday, August 19th.
2. We will discuss all of our findings and come to a decision during the Friday meeting, August 21st.

Is your feature request related to a problem? Please describe.
Currently, reviewers need to be manually selected / added to PRs.

Describe the solution you'd like
We should take advantage of GItHub's Code Owners feature to make adding reviewers to PRs easier.

Describe alternatives you've considered
GitHub doesn't seem to have repo configuration settings for adding default reviewers like BitBucket does.

Motivation

As a developer, I would like to benefit from code hinting and a better editing experience overall.

Is your feature request related to a problem? Please describe.

Code editing is done within a docker container, which is often inaccessible to IDE's like sublime text or even vim.

Proposed Resolution

Describe the solution you'd like

Add info about IDE integration into docker container directories.

Original D7 issue: https://jira.arizona.edu/browse/UADIGITAL-1419

What is the problem that we want to solve?

User story

As a Quickstart site administrator, I need to be able to automatically provision and de-provision Drupal user accounts and roles based on Grouper group membership(s) and potentially other attributes from a central directory.

Background

Many University websites are administered or supported by one or more teams. Some teams support a large number of websites. The task of ensuring that team members have appropriate administrative access to all team-supported websites is compounded for teams with a a lot of turnover (e.g. teams that employ a lot of student employees).

Grouper is an enterprise-wide group management system for university related groups of people, teams, or departments. Grouper is well suited as an authorization system for role-based access to other systems or resources.

Potential solutions

• In July 2016, Patrick at the Graduate College published a guide for configuring the contrib Drupal LDAP module (and some of its submodules) to automatically add roles to existing Drupal user accounts based on Grouper group membership data queried from EDS. This solution does provide a way to automate role provisioning for existing Drupal users but does not provide a way to automatically provision or de-provision Drupal accounts for group members.
• The contrib simpleSAMLphp Authentication module available for Drupal 7 & 8 has built-in functionality for just-in-time provisioning of accounts and automatic role assignment based on SAML attributes.

Conditions of satisfaction

• The considered options are documented
• A recommended next step is documented
• An estimate of time and effort is provided for the recommendation
• …

Conditions of satisfaction

• "drupal/bootstrap_barrio": "4.22", updated in composer.json to "drupal/bootstrap_barrio": "4.23",
• missing theme config schema patch removed from composer.json.

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Maintain UA Zen functionality

We need to make the decision on whether or not to use Display Suite during the next Workshop.

The rest of the Arizona Barrio work has been moved into the Finish Barrio epic which can be completed after we finish up either the Navigation or Flexible Page epics.

Problem/Motivation

The default path provided for the bootstrap option in our phpunit.xml.dist configuration file works for ProboCI but does not work for lando or ddev.

Describe the bug

In our phpunit.xml.dist configuration file we current specify these top level attributes:
<phpunit bootstrap="../../../core/tests/bootstrap.php" colors="true">
The path provided for the bootstrap script was based on what worked for ProboCI. Unfortunately, in order for someone to run our PHPUnit tests with lando or ddev, they need to modify that value to be /app/web/core/tests/bootstrap.php.

To Reproduce

Try running phpunit inside a lando or ddev container.

Proposed resolution

We should either make the bootstrap value provided in phpunit.xml.dist be something that works on more environments or consider removing it and document how to specify a bootstrap value at runtime using the --bootstrap command line option.

Expected behavior

Someone following our documented steps for running PHPUnit tests should not need to make changes to the phpunit.xml.dist file. Our ProboCI configuration could be changed to provide runtime configuration options as needed.

Describe the bug

On line 148 of modules/custom/az_core/src/Form/QuickstartCoreSettingsForm.php the != operator is used.

Expected behavior

We should use !== unless we explicitly want to convert type.

Do not disclose security vulnerabilities here, please email us instead:
[email protected]

Conditions of satisfaction

• A submitted pull request should include az-digital/developers as reviewers
• A submitted pull request should be added to az quickstart project

What is the problem that we want to solve?

There is an initiative underway to create a design system that all designers across campus can use to design components for web and mobile apps.

With this in mind, we may need to decouple component design from Drupal into a component designer like storybook with arizona bootstrap and drupal integration.

This will not solve for other frameworks like angular or react, but could make it easier to convert from one framework to another.

Here is an article to follow when creating the proof of concept. https://medium.com/@askibinski/integrating-storybook-with-drupal-ddabfc6c2f9d

Conditions of satisfaction

• The considered options are documented
• A recommended next step is documented
• An estimate of time and effort is provided for the recommendation

There should be easy to find instructions on how to contribute to this project. Some things to include would be:

• How to report bugs/issues
• How to submit changes
• Coding conventions
• Where to ask questions

Have a way to deliver QS through Pantheon

User Story(s)

As a site administrator, I'd like to be able to send mail from my site.

Conditions of satisfaction

• The mail module/library we choose supports attachments correctly (including inline attachments)
• The mail module/library we choose should work with the Rules module

Maintain current functionality

Determine if part of MVP and where in priority

Problem/Motivation

https://www.drupal.org/sa-core-2020-001

Proposed resolution

Update Drupal core to version 8.8.4.

Motivation

Several features were not added or not enabled with the initial AZ Barrio theme that exist in UA Zen. There are also some new features in UA Zen that should be imported to AZ Barrio.

Proposed Resolution

Describe the solution you'd like

Continue AZ Barrio development for UA Zen parity.