feat(remove-android): Update docs (#6755)
#### Details Remove Android references from docs ##### Motivation Android deprecation feature ##### Context <!-- Are there any parts that you've intentionally left out-of-scope for a later PR to handle? --> <!-- Were there any alternative approaches you considered? What tradeoffs did you consider? --> #### Pull request checklist <!-- If a checklist item is not applicable to this change, write "n/a" in the checkbox --> - [n/a] Addresses an existing issue (part of Android deprecation feature) - [x] Ran `yarn fastpass` - [n/a] Added/updated relevant unit test(s) (and ran `yarn test`) - [n/a] Verified code coverage for the changes made. Check coverage report at: `<rootDir>/test-results/unit/coverage` - [x] PR title *AND* final merge commit title both start with a semantic tag (`fix:`, `chore:`, `feat(feature-name):`, `refactor:`). See `CONTRIBUTING.md`. - [x] (UI changes only) Added screenshots/GIFs to description above - [x] (UI changes only) Verified usability with NVDA/JAWS
This commit is contained in:
Dave Tryon
GitHub
Родитель
412679d14d
Коммит
8665e7a870
|
|
@ -38,10 +38,9 @@ The convention that we follow is inspired from [SemVer](https://semver.org/) con
|
|||
Some examples of good PR titles are:
|
||||
|
||||
- `refactor: rename FooWidget to BarWidget`
|
||||
- `feat(android-settings): add High Contrast toggle to unified settings panel`
|
||||
- `feat(high-contrast-settings): add High Contrast toggle to settings panel`
|
||||
|
||||
## Further Guidance
|
||||
|
||||
- [Git branch setup](./docs/git-branch-setup.md)
|
||||
- [Building Accessibility Insights for Web](./docs/building-web.md)
|
||||
- [Building Accessibility Insights for Android (Unified)](./docs/building-unified.md)
|
||||
|
|
|
|||
17
README.md
17
README.md
|
|
@ -3,7 +3,7 @@ Copyright (c) Microsoft Corporation. All rights reserved.
|
|||
Licensed under the MIT License.
|
||||
-->
|
||||
|
||||
##  Accessibility Insights for Web & Android
|
||||
##  Accessibility Insights for Web
|
||||
|
||||
[](https://dev.azure.com/accessibility-insights/accessibility-insights-web/_build/latest?definitionId=37&branchName=main)
|
||||
[](https://codecov.io/gh/microsoft/accessibility-insights-web)
|
||||
|
|
@ -11,13 +11,7 @@ Licensed under the MIT License.
|
|||
[](https://chrome.google.com/webstore/detail/accessibility-insights-fo/pbjjkligggfmakdaogkfomddhfmpjeni)
|
||||
[](https://chrome.google.com/webstore/detail/accessibility-insights-fo/pbjjkligggfmakdaogkfomddhfmpjeni/reviews)
|
||||
|
||||
Two projects are built from this repository:
|
||||
|
||||
- **Accessibility Insights for Web** is a browser extension for Google Chrome and the new Microsoft Edge, used for assessing the accessibility of web sites and web applications.
|
||||
- **Accessibility Insights for Android** is a cross-platform desktop tool used for testing accessibility of Android applications.
|
||||
|
||||
### Notice
|
||||
The Accessibility Insights team is proud to provide accessibility scanning solutions across multiple platforms including Web, Windows Desktop, and Android. Unfortunately, the usage of Accessibility Insights for Android did not meet expectations and we will be **ending support of that product** effective June 1 2023, so we can focus on our more popular products for Web and Windows Desktop. The product download link will be removed to promote security and discourage use of an unmaintained version of the product. The source code will remain available under the MIT open-source license. We are grateful to the community who continue to use our accessibility testing products!
|
||||
This repository contains the code for **Accessibility Insights for Web**, which is a browser extension for Google Chrome and the new Microsoft Edge. It is used for assessing the accessibility of web sites and web applications.
|
||||
|
||||
### Install Accessibility Insights for Web
|
||||
|
||||
|
|
@ -25,12 +19,6 @@ The Accessibility Insights team is proud to provide accessibility scanning solut
|
|||
-  [Insider](https://chrome.google.com/webstore/detail/nnmjfbmebeckhpejobgjjjnchlljiagp) (on feature completion)
|
||||
-  [Production](https://chrome.google.com/webstore/detail/pbjjkligggfmakdaogkfomddhfmpjeni) (after validation in Insider)
|
||||
|
||||
### Install Accessibility Insights for Android
|
||||
|
||||
- MacOS ([Canary](https://aka.ms/accessibility-insights-for-android/downloads/CanaryMacOS), [Insider](https://aka.ms/accessibility-insights-for-android/downloads/InsiderMacOS), [Production](https://aka.ms/accessibility-insights-for-android/downloads/MacOS))
|
||||
- Windows ([Canary](https://aka.ms/accessibility-insights-for-android/downloads/CanaryWindows), [Insider](https://aka.ms/accessibility-insights-for-android/downloads/InsiderWindows), [Production](https://aka.ms/accessibility-insights-for-android/downloads/Windows))
|
||||
- Linux ([Canary](https://aka.ms/accessibility-insights-for-android/downloads/CanaryLinux), [Insider](https://aka.ms/accessibility-insights-for-android/downloads/InsiderLinux), [Production](https://aka.ms/accessibility-insights-for-android/downloads/Linux))
|
||||
|
||||
## Data/Telemetry
|
||||
|
||||
By opting into telemetry, you [help the community](https://go.microsoft.com/fwlink/?linkid=2077765) develop inclusive software. We collect anonymized data to identify the top accessibility issues found by the users. This will help focus the accessibility tools and standards community to improve guidelines, rules engines, and features.
|
||||
|
|
@ -56,7 +44,6 @@ All contributions are welcome! To get started, please read through our [CONTRIBU
|
|||
- [Git branch setup](./docs/git-branch-setup.md)
|
||||
- [Virus scanner exclusions](./docs/virus-scanner-exclusions.md)
|
||||
- [Building Accessibility Insights for Web](./docs/building-web.md)
|
||||
- [Building Accessibility Insights for Android (Unified)](./docs/building-unified.md)
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
|
|
|
|||
|
|
@ -1,73 +0,0 @@
|
|||
<!--
|
||||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
Licensed under the MIT License.
|
||||
-->
|
||||
|
||||
## Building Accessibility Insights for Android (Unified)
|
||||
|
||||
This document describes how to build and test Accessibility Insights for Android (the Electron app). Much of the information/code is shared between it and Accessibility Insights for Web (the browser extension); see [Building Accessibility Insights for Web](./building-web.md) for the shared and web-specific guidance.
|
||||
|
||||
### "Unified"?
|
||||
|
||||
Throughout most of the code and build commands, Accessibility Insights for Android is referred to as "unified"; this is because we expect it may eventually serve as a client for accessibility assessments of many different platforms, not just Android. Today, Android is the only platform the "unified" app supports, and you can generally think of "unified" and "for Android" interchangeably.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
All the [prerequisites](./building-web.md#Prerequisites) for building Web are also required for Unified.
|
||||
|
||||
**Additionally**, you must [install the .NET 6.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0). Use the current LTS version. You can test whether you already have this installed by running `dotnet --list-sdks`.
|
||||
|
||||
Note that if you have Hadoop YARN installed, you will need to replace `yarn` with `yarnpkg` in the commands below.
|
||||
|
||||
### Building
|
||||
|
||||
```sh
|
||||
# One-time build
|
||||
yarn build:unified
|
||||
|
||||
# Continuously rebuilds as you modify files
|
||||
yarn watch:build:unified
|
||||
|
||||
# Build all release variants (rarely necessary, only if modifying release infrastructure)
|
||||
yarn build:unified:all
|
||||
```
|
||||
|
||||
### Running Locally
|
||||
|
||||
Most of the functionality of Unified relies on connecting to a device running the Accessibility Insights for Android Service. However, most Unified development and testing does not require an actual Android device/VM; this repository includes a tool called `mock-adb` that can be used to fake having one for most purposes.
|
||||
|
||||
#### Using a mock device
|
||||
|
||||
We use a test tool called `mock-adb` to enable testing against mock devices. See the [`mock-adb` README](../packages/mock-adb/README.md) for details.
|
||||
|
||||
#### Connecting to a real device/emulator
|
||||
|
||||
If you _do_ need to work with an actual Android device/VM, you'll want to install [Android Studio](https://developer.android.com/studio/) and use it to connect to a device and/or start an emulator. The Unified app will automatically detect and install the [Accessibility Insights for Android Service](https://github.com/microsoft/accessibility-insights-for-android-service) onto your device; see [Getting Started with Accessibility Insights for Android](https://accessibilityinsights.io/docs/en/android/getstarted/setup#getting-started-with-accessibility-insights-for-android) for more info on how to prepare a device/emulator with the Accessibility Insights for Android Service.
|
||||
|
||||
Note: If you want to use a modified version of Accessibility Insights for Android Service, follow the [Manual installation](https://accessibilityinsights.io/docs/en/android/getstarted/setup/#manual-installation) steps. Then, make a [small modification to the Unified app](https://github.com/microsoft/accessibility-insights-web/pull/4395) to bypass the Android Service version check. **Do not push this change.**
|
||||
|
||||
```sh
|
||||
yarn start:unified:dev
|
||||
```
|
||||
|
||||
### Testing
|
||||
|
||||
**Unit tests** use exactly the same commands as in Web (`yarn test`, etc). See [Building Accessibility Insights for Web: Unit Tests](./building-web.md#unit-tests).
|
||||
|
||||
**End-to-end tests** for Unified are separated from Web's end-to-end tests. To run them:
|
||||
|
||||
```sh
|
||||
# Run all unified E2E tests
|
||||
yarn test:unified
|
||||
|
||||
# Update snapshots
|
||||
yarn test:unified -u
|
||||
```
|
||||
|
||||
### Debugging in VS Code
|
||||
|
||||
To debug the built app in Code, you can run the `Debug electron main process with --remote-debugging-port=9222` configuration. Once this is running, you can debug the renderer process via the `Attach debugger to electron renderer process` configuration.
|
||||
|
||||
### Using Chrome DevTools
|
||||
|
||||
To debug the renderer process, you can run the application with `yarn start:unified:dev`. This will start the dev flavor of the unified app with the environment variable 'DEV_MODE' set to 'true'. The app should open with a detached DevTools instance. See more info [here](https://www.electronjs.org/docs/tutorial/application-debugging#renderer-process). This allows you to inspect the DOM, programmatically set feature flags (e.g. `featureFlagsController.enableFeature("logTelemetryToConsole")`), or modify persisted data in the Application tab. You can set this environment variable user/system-wide if needed for non-dev-flavor workflows.
|
||||
|
|
@ -5,7 +5,7 @@ Licensed under the MIT License.
|
|||
|
||||
## Building Accessibility Insights for Web
|
||||
|
||||
This document describes how to build and test Accessibility Insights for Web (the browser extension). Much of the information/code is shared between it and Accessibility Insights for Android (the "unified" Electron app); for guidance specific to Unified, see [Building Accessibility Insights for Android (Unified)](./building-unified.md).
|
||||
This document describes how to build and test Accessibility Insights for Web (the browser extension).
|
||||
|
||||
### Prerequisites
|
||||
|
||||
|
|
|
|||
|
|
@ -18,23 +18,15 @@ At minimum, we plan to use individual packages for each individually released pr
|
|||
|
||||
* `/packages/report`: `accessibility-insights-report` (NPM package, primarily for consumption by [accessibility-insights-service](https://github.com/microsoft/accessibility-insights-service))
|
||||
* `/packages/ui`: `accessibility-insights-ui` (NPM package, primarily for consumption by [accessibilityinsights.io](https://accessibilityinsights.io))
|
||||
* `/packages/unified`: Accessibility Insights for Android (Electron application)
|
||||
* `/packages/web`: Accessibility Insights for Web (browser extension)
|
||||
|
||||
We will start out with having unified and web still combined under `/packages/web`; they will
|
||||
require some work to split out.
|
||||
|
||||
We also plan to move end-to-end tests of packages into separate packages, to better test "true"
|
||||
We plan to move end-to-end tests of packages into separate packages, to better test "true"
|
||||
package API boundaries. For example:
|
||||
|
||||
* `/packages/report-e2e-tests`: End-to-end tests of the `report` package APIs
|
||||
|
||||
## Longer term (2021+) plans
|
||||
|
||||
Some functionality of web/unified may gradually get extracted to separate packages
|
||||
for the purposes of improving build time/encapsulation; for example, some of the subdirectories
|
||||
currently under `/src` might turn into separate packages one day.
|
||||
|
||||
Eventually, we could imagine wanting to combine `accessibility-insights-service` and
|
||||
`accessibility-insights-web` into one monorepo; we aren't sure whether we necessarily want to do
|
||||
this or not, but in the interest of keeping it easy, we want to lean towards using consistent
|
||||
|
|
@ -45,4 +37,4 @@ per-package", etc.
|
|||
|
||||
* `/packages/ui`: current home of former `/src/packages/accessibility-insights-ui/root`
|
||||
* `/packages/report`: current home of former `/src/reports/package/root`
|
||||
* `/package.json`/`/src`: current home of web, unified, and most of the build rules for ui/report
|
||||
* `/package.json`/`/src`: current home of web and most of the build rules for ui/report
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче