Skip to content

Commit

Permalink
Docs (#161)
Browse files Browse the repository at this point in the history
* Removes Pa11y

* Updates documentation

* Updates errant json

* Adds Coder as a dev module

* Removes lock files
  • Loading branch information
thejimbirch committed Feb 15, 2024
1 parent c1443e0 commit 68f4957
Show file tree
Hide file tree
Showing 8 changed files with 29 additions and 58 deletions.
4 changes: 3 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@
"rvtraveller/qs-composer-installer": "^1.1"
},
"require-dev": {
"drupal/coder": "^8.3",
"drupal/core-dev": "^10.2",
"drupal/devel": "^5.1",
"drupal/devel": "^5.1",
"palantirnet/drupal-rector": "^0.19"
},
"conflict": {
Expand Down Expand Up @@ -172,6 +173,7 @@
},
"drupal/gin": {
"Resolve Missing Dependency 'core/once' in Gin_accent Library": "https://git.drupalcode.org/project/gin/-/merge_requests/380.patch"
}
}
},
"config": {
Expand Down
16 changes: 8 additions & 8 deletions docs/ABOUT.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,21 +119,21 @@ composer.json
"require-dev": {
"drupal/core-dev": "^10.2",
"drupal/devel": "^5.1",
"drupal/upgrade_status": "^4.0",
"palantirnet/drupal-rector": "^0.19"
},
```
This may seem simpler than past iterations, but Upgrade Status requires PHPstan
and PHPcs. We just need to remember tht when we upgrade them, we need to
upgrade the rector.php and phpstan.neon files in the root of our project.
This may seem simpler than past iterations, but Drupal Rector requires PHPstan
which in turn requires PHPcs. We just need to remember that when we upgrade
versions, we need to upgrade the rector.php and phpstan.neon files in the root
of our project.

The tests are preconfigured in the scripts section of the composer.json. So we
can run them locally, pre-commit or pre-push using Lefthook, and in CircleCI.
Anywhwere the site is installed using composer with the dev modules.
Anywhere the site is installed using composer with the dev modules.

At this time, we run 4 pre-build static code tests, PHPcs, PHPstan, Rector -
modules, and Rector - themes. These tests are now a requirement to pass before
code can be merged.
At this time, we run 4 pre-build static code tests, `PHPcs`, `PHPstan`, `Rector
- modules`, and `Rector - themes`. These tests are now a requirement to pass
before code can be merged.

### Post Build tests.

Expand Down
11 changes: 8 additions & 3 deletions docs/EMULSIFY.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Emulsfy theme configuration

## NOTE: This repository is no longer configured to compile Emulsify.

Please refer to releases before 10.2.3 for that CircleCI/Docksal code.

The theme is based off the
[Kanopi Design Component Library](https://github.com/kanopi/kdcl_basic)
Expand All @@ -17,13 +22,13 @@ The theme uses Webpack and NPM to manage packages and run scripts.
- @TODO
[Hot Reloading in Drupal](https://docs.emulsify.info/usage/hot-reload-drupal)

#### Storybook
## Storybook

- Theme development run `fin npm run develop`. This will watch for twig, js,
and sass changes within the components directory.
- The development storybook URL http://storybook.${VIRTUAL_HOST}

#### Storybook Webpack
## Storybook Webpack
For webpack storybook to work within a docksal container we needed
to set `watchOptions` in
`docroot/themes/custom/THEME/.storybook/webpack.config.js`
Expand All @@ -34,7 +39,7 @@ config.watchOptions = {
}
```

### Theme Commands
## Theme Commands

The following commands are available with Node and should be prefixed with the
command `fin npm run`.
Expand Down
4 changes: 4 additions & 0 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ Pantheon, CircleCI, and local Docksal development.

-----

## Installer method

@kanopians - Please use the internal, private repository.

## CLI installation method


Expand Down
21 changes: 6 additions & 15 deletions docs/TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,17 +94,8 @@ The project comes with [kanopi/shrubs](https://packagist.org/packages/kanopi/shr

### Pa11y Audits

We have a Docksal command that will run [pa11y-ci](https://github.com/pa11y/pa11y-ci)
audits `fin pa11y`. When the command finishes the reports are available at the
following url pa11y.$VIRTUAL_HOST

If you want to change the configuration of the Pa11y tests you can edit the
[.pa11yci.js](/tests/pa11y/.pa11yci.js) file.

Note: This was forked from [Phase2](https://github.com/phase2/pa11y-dashboard)

We also have a pa11y audit that runs in CircleCI and posts a comment to the
GitHub repository's pull request if the audit fails.
We have a pa11y audit that runs in CircleCI and posts a comment to the GitHub
repository's pull request if the audit fails.

### Lighthouse

Expand All @@ -115,13 +106,13 @@ internet.

Type | Minimum Score
-----|--------------
accessibility | 88
best-practices| 79
performance | 55
seo | 92
accessibility | 89
best-practices| 96
seo | 93

Developers are also encouraged to run Lighthouse locally using browser plugins,
or Lighthouse's CLI.
or [Lighthouse CLI](https://github.com/GoogleChrome/lighthouse?tab=readme-ov-file#using-the-node-cli).

### Backstop.js Visual Regression

Expand Down
2 changes: 0 additions & 2 deletions tests/pa11y/.gitignore

This file was deleted.

22 changes: 0 additions & 22 deletions tests/pa11y/.pa11yci.js

This file was deleted.

7 changes: 0 additions & 7 deletions tests/pa11y/pa11y2json.js

This file was deleted.

0 comments on commit 68f4957

Please sign in to comment.