Commit 42f3ac80 authored by Scott Hampton's avatar Scott Hampton Committed by Amy Qualls

Add feature flag docs for a11y widget

The a11y MR widget will be released behind a feature flag
that is disabled by default. This updates the documentation
to explain how to enable the feature flag.
parent 94e205ef
...@@ -18,11 +18,23 @@ measuring the accessibility of web sites, and has built a simple ...@@ -18,11 +18,23 @@ measuring the accessibility of web sites, and has built a simple
This job outputs accessibility violations, warnings, and notices for each page This job outputs accessibility violations, warnings, and notices for each page
analyzed to a file called `accessibility`. analyzed to a file called `accessibility`.
## Accessibility Merge Request widget
[Since GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/39425), in addition to the report artifact that is created, GitLab will also show the [Since GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/39425), in addition to the report artifact that is created, GitLab will also show the
Accessibility Report in the merge request widget area: Accessibility Report in the merge request widget area:
![Accessibility Merge Request Widget](img/accessibility_mr_widget_v13_0.png) ![Accessibility Merge Request Widget](img/accessibility_mr_widget_v13_0.png)
This widget comes with the `:accessibility_report_view` feature flag disabled by default while we test feature stability.
Once we have determined the widget is stable, this feature will be enabled by default.
To enable this feature, ask a GitLab administrator with [Rails console access](../../../administration/feature_flags.md#how-to-enable-and-disable-features-behind-flags) to run the
following command:
```ruby
Feature.enable(:accessibility_report_view)
```
## Configure Accessibility Testing ## Configure Accessibility Testing
This example shows how to run [pa11y](https://pa11y.org/) This example shows how to run [pa11y](https://pa11y.org/)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment