Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

Fix outdated links across a number of markdown files #3276

Merged
merged 26 commits into from
Dec 18, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

[![Build Status](https://api.cirrus-ci.com/github/flutter/plugins.svg)](https://cirrus-ci.com/github/flutter/plugins/master)

_See also: [Flutter's code of conduct](https://flutter.io/design-principles/#code-of-conduct)_
_See also: [Flutter's code of conduct](https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md)_

## Things you will need

Expand Down Expand Up @@ -131,17 +131,16 @@ pub global run flutter_plugin_tools xctest --target RunnerUITests --skip <plugin
We gladly accept contributions via GitHub pull requests.

Please peruse our
[style guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo) and
[design principles](https://flutter.io/design-principles/) before
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

working on anything non-trivial. These guidelines are intended to
[style guide](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo)
before working on anything non-trivial. These guidelines are intended to
keep the code consistent and avoid common pitfalls.

To start working on a patch:

* `git fetch upstream`
* `git checkout upstream/master -b <name_of_your_branch>`
* Hack away.
* Verify changes with [flutter_plugin_tools](https://pub.dartlang.org/packages/flutter_plugin_tools)
* Verify changes with [flutter_plugin_tools](https://pub.dev/packages/flutter_plugin_tools)
```
pub global activate flutter_plugin_tools
pub global run flutter_plugin_tools format --plugins plugin_name
Expand Down
6 changes: 3 additions & 3 deletions packages/android_alarm_manager/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# android_alarm_manager

[![pub package](https://img.shields.io/pub/v/android_alarm_manager.svg)](https://pub.dartlang.org/packages/android_alarm_manager)
[![pub package](https://img.shields.io/pub/v/android_alarm_manager.svg)](https://pub.dev/packages/android_alarm_manager)

A Flutter plugin for accessing the Android AlarmManager service, and running
Dart code in the background when alarms fire.
Expand Down Expand Up @@ -121,6 +121,6 @@ register plugins. This can be resolved by running `flutter upgrade` to upgrade
to the latest Flutter version.**

For help getting started with Flutter, view our online
[documentation](http://flutter.io/).
[documentation](https://flutter.dev/).

For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code).
For help on editing plugin code, view the [documentation](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin).
8 changes: 4 additions & 4 deletions packages/android_intent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,20 +53,20 @@ if (platform.isAndroid) {
Feel free to add support for additional Android intents.

The Dart values supported for the arguments parameter, and their corresponding
Android values, are listed [here](https://flutter.io/platform-channels/#codec).
Android values, are listed [here](https://flutter.dev/docs/development/platform-integration/platform-channels#codec).
On the Android side, the arguments are used to populate an Android `Bundle`
instance. This process currently restricts the use of lists to homogeneous lists
of integers or strings.

> Note that a similar method does not currently exist for iOS. Instead, the
[url_launcher](https://pub.dartlang.org/packages/url_launcher) plugin
[url_launcher](https://pub.dev/packages/url_launcher) plugin
can be used for deep linking. Url launcher can also be used for creating
ACTION_VIEW intents for Android, however this intent plugin also allows
clients to set extra parameters for the intent.

## Getting Started

For help getting started with Flutter, view our online
[documentation](http://flutter.io/).
[documentation](https://flutter.dev/).

For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code).
For help on editing plugin code, view the [documentation](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin).
4 changes: 2 additions & 2 deletions packages/battery/battery/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Battery

[![pub package](https://img.shields.io/pub/v/battery.svg)](https://pub.dartlang.org/packages/battery)
[![pub package](https://img.shields.io/pub/v/battery.svg)](https://pub.dev/packages/battery)

A Flutter plugin to access various information about the battery of the device the app is running on.

## Usage
To use this plugin, add `battery` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
To use this plugin, add `battery` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).

### Example

Expand Down
4 changes: 2 additions & 2 deletions packages/camera/camera/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Camera Plugin

[![pub package](https://img.shields.io/pub/v/camera.svg)](https://pub.dartlang.org/packages/camera)
[![pub package](https://img.shields.io/pub/v/camera.svg)](https://pub.dev/packages/camera)

A Flutter plugin for iOS and Android allowing access to the device cameras.

Expand All @@ -15,7 +15,7 @@ A Flutter plugin for iOS and Android allowing access to the device cameras.

## Installation

First, add `camera` as a [dependency in your pubspec.yaml file](https://flutter.io/using-packages/).
First, add `camera` as a [dependency in your pubspec.yaml file](https://flutter.dev/using-packages/).

### iOS

Expand Down
4 changes: 2 additions & 2 deletions packages/camera/camera/lib/camera.dart
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ class CameraController extends ValueNotifier<CameraValue> {
/// Captures an image and saves it to [path].
///
/// A path can for example be obtained using
/// [path_provider](https://pub.dartlang.org/packages/path_provider).
/// [path_provider](https://pub.dev/packages/path_provider).
///
/// If a file already exists at the provided path an error will be thrown.
/// The file can be read as this function returns.
Expand Down Expand Up @@ -507,7 +507,7 @@ class CameraController extends ValueNotifier<CameraValue> {
/// Start a video recording and save the file to [path].
///
/// A path can for example be obtained using
/// [path_provider](https://pub.dartlang.org/packages/path_provider).
/// [path_provider](https://pub.dev/packages/path_provider).
///
/// The file is written on the flight as the video is being recorded.
/// If a file already exists at the provided path an error will be thrown.
Expand Down
4 changes: 2 additions & 2 deletions packages/connectivity/connectivity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ Note that connectivity changes are no longer communicated to Android apps in the
## Getting Started

For help getting started with Flutter, view our online
[documentation](http://flutter.io/).
[documentation](https://flutter.dev/).

For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code).
For help on editing plugin code, view the [documentation](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin).
2 changes: 1 addition & 1 deletion packages/cross_file/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ final fileContent = await file.readAsString();
print('Content of the file: ${fileContent}'); // e.g. "Moto G (4)"
```

You will find links to the API docs on the [pub page](https://pub.dartlang.org/packages/cross_file).
You will find links to the API docs on the [pub page](https://pub.dev/packages/cross_file).

## Getting Started

Expand Down
6 changes: 3 additions & 3 deletions packages/device_info/device_info/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ IosDeviceInfo iosInfo = await deviceInfo.iosInfo;
print('Running on ${iosInfo.utsname.machine}'); // e.g. "iPod7,1"
```

You will find links to the API docs on the [pub page](https://pub.dartlang.org/packages/device_info).
You will find links to the API docs on the [pub page](https://pub.dev/packages/device_info).

## Getting Started

For help getting started with Flutter, view our online
[documentation](http://flutter.io/).
[documentation](https://flutter.dev/).

For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code).
For help on editing plugin code, view the [documentation](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin).
4 changes: 2 additions & 2 deletions packages/flutter_plugin_android_lifecycle/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Flutter Android Lifecycle Plugin

[![pub package](https://img.shields.io/pub/v/flutter_plugin_android_lifecycle.svg)](https://pub.dartlang.org/packages/flutter_plugin_android_lifecycle)
[![pub package](https://img.shields.io/pub/v/flutter_plugin_android_lifecycle.svg)](https://pub.dev/packages/flutter_plugin_android_lifecycle)

A Flutter plugin for Android to allow other Flutter plugins to access Android `Lifecycle` objects
in the plugin's binding.
Expand All @@ -11,7 +11,7 @@ major version of the Android `Lifecycle` API they expect.

## Installation

Add `flutter_plugin_android_lifecycle` as a [dependency in your pubspec.yaml file](https://flutter.io/using-packages/).
Add `flutter_plugin_android_lifecycle` as a [dependency in your pubspec.yaml file](https://flutter.dev/using-packages/).

## Example

Expand Down
4 changes: 2 additions & 2 deletions packages/google_maps_flutter/google_maps_flutter/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Google Maps for Flutter

[![pub package](https://img.shields.io/pub/v/google_maps_flutter.svg)](https://pub.dartlang.org/packages/google_maps_flutter)
[![pub package](https://img.shields.io/pub/v/google_maps_flutter.svg)](https://pub.dev/packages/google_maps_flutter)

A Flutter plugin that provides a [Google Maps](https://developers.google.com/maps/) widget.

## Usage

To use this plugin, add `google_maps_flutter` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
To use this plugin, add `google_maps_flutter` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).

## Getting Started

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Demonstrates how to use the google_sign_in plugin with the `googleapis` package.
## Getting Started

For help getting started with Flutter, view our online
[documentation](http://flutter.io/).
[documentation](https://flutter.dev/).
4 changes: 2 additions & 2 deletions packages/google_sign_in/google_sign_in/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# google_sign_in

[![pub package](https://img.shields.io/pub/v/google_sign_in.svg)](https://pub.dartlang.org/packages/google_sign_in)
[![pub package](https://img.shields.io/pub/v/google_sign_in.svg)](https://pub.dev/packages/google_sign_in)

A Flutter plugin for [Google Sign In](https://developers.google.com/identity/).

Expand Down Expand Up @@ -63,7 +63,7 @@ plugin could be an option.
## Usage

### Import the package
To use this plugin, follow the [plugin installation instructions](https://pub.dartlang.org/packages/google_sign_in#pub-pkg-tab-installing).
To use this plugin, follow the [plugin installation instructions](https://pub.dev/packages/google_sign_in#pub-pkg-tab-installing).

### Use the plugin
Add the following import to your Dart code:
Expand Down
4 changes: 2 additions & 2 deletions packages/image_picker/image_picker/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Image Picker plugin for Flutter

[![pub package](https://img.shields.io/pub/v/image_picker.svg)](https://pub.dartlang.org/packages/image_picker)
[![pub package](https://img.shields.io/pub/v/image_picker.svg)](https://pub.dev/packages/image_picker)

A Flutter plugin for iOS and Android for picking images from the image library,
and taking new pictures with the camera.

## Installation

First, add `image_picker` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
First, add `image_picker` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).

### iOS

Expand Down
2 changes: 1 addition & 1 deletion packages/in_app_purchase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ WARNING! Failure to call `InAppPurchaseConnection.completePurchase` and get a su
## Development

This plugin uses
[json_serializable](https://pub.dartlang.org/packages/json_serializable) for the
[json_serializable](https://pub.dev/packages/json_serializable) for the
many data structs passed between the underlying platform layers and Dart. After
editing any of the serialized data structs, rebuild the serializers by running
`flutter packages pub run build_runner build --delete-conflicting-outputs`.
Expand Down
4 changes: 2 additions & 2 deletions packages/local_auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,6 @@ app resumes.
## Getting Started

For help getting started with Flutter, view our online
[documentation](http://flutter.io/).
[documentation](https://flutter.dev/).

For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code).
For help on editing plugin code, view the [documentation](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin).
4 changes: 2 additions & 2 deletions packages/path_provider/path_provider/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# path_provider

[![pub package](https://img.shields.io/pub/v/path_provider.svg)](https://pub.dartlang.org/packages/path_provider)
[![pub package](https://img.shields.io/pub/v/path_provider.svg)](https://pub.dev/packages/path_provider)

A Flutter plugin for finding commonly used locations on the filesystem. Supports iOS, Android, Linux and MacOS.
Not all methods are supported on all platforms.

## Usage

To use this plugin, add `path_provider` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
To use this plugin, add `path_provider` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).

### Example

Expand Down
4 changes: 2 additions & 2 deletions packages/quick_actions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ quick action.
## Getting Started

For help getting started with Flutter, view our online
[documentation](http://flutter.io/).
[documentation](https://flutter.dev/).

For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code).
For help on editing plugin code, view the [documentation](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin).
2 changes: 1 addition & 1 deletion packages/sensors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A Flutter plugin to access the accelerometer and gyroscope sensors.
## Usage

To use this plugin, add `sensors` as a [dependency in your pubspec.yaml
file](https://flutter.io/platform-plugins/).
file](https://flutter.dev/docs/development/platform-integration/platform-channels).

This will expose three classes of sensor events, through three different
streams.
Expand Down
4 changes: 2 additions & 2 deletions packages/share/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Share plugin

[![pub package](https://img.shields.io/pub/v/share.svg)](https://pub.dartlang.org/packages/share)
[![pub package](https://img.shields.io/pub/v/share.svg)](https://pub.dev/packages/share)

A Flutter plugin to share content from your Flutter app via the platform's
share dialog.
Expand All @@ -17,7 +17,7 @@ For more details see: https://github.com/flutter/flutter/wiki/Package-migration-

## Usage

To use this plugin, add `share` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
To use this plugin, add `share` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).

## Example

Expand Down
4 changes: 2 additions & 2 deletions packages/shared_preferences/shared_preferences/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Shared preferences plugin

[![pub package](https://img.shields.io/pub/v/shared_preferences.svg)](https://pub.dartlang.org/packages/shared_preferences)
[![pub package](https://img.shields.io/pub/v/shared_preferences.svg)](https://pub.dev/packages/shared_preferences)

Wraps platform-specific persistent storage for simple data
(NSUserDefaults on iOS and macOS, SharedPreferences on Android, etc.). Data may be persisted to disk asynchronously,
Expand All @@ -16,7 +16,7 @@ Please use `shared_preferences: '>=0.5.y+x <2.0.0'` as your dependency constrain
For more details see: https://github.com/flutter/flutter/wiki/Package-migration-to-1.0.0

## Usage
To use this plugin, add `shared_preferences` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
To use this plugin, add `shared_preferences` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).

### Example

Expand Down
6 changes: 3 additions & 3 deletions packages/url_launcher/url_launcher/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# url_launcher

[![pub package](https://img.shields.io/pub/v/url_launcher.svg)](https://pub.dartlang.org/packages/url_launcher)
[![pub package](https://img.shields.io/pub/v/url_launcher.svg)](https://pub.dev/packages/url_launcher)

A Flutter plugin for launching a URL in the mobile platform. Supports
iOS, Android, web, Windows, macOS, and Linux.
Expand Down Expand Up @@ -38,7 +38,7 @@ _launchURL() async {

## Supported URL schemes

The [`launch`](https://www.dartdocs.org/documentation/url_launcher/latest/url_launcher/launch.html) method
The [`launch`](https://pub.dev/documentation/url_launcher/latest/url_launcher/launch.html) method
takes a string argument containing a URL. This URL
can be formatted using a number of different URL schemes. The supported
URL schemes depend on the underlying platform and installed apps.
Expand Down Expand Up @@ -83,7 +83,7 @@ launching a URL using the `sms` scheme, or a device may not have an email app
and thus no support for launching a URL using the `email` scheme.

We recommend checking which URL schemes are supported using the
[`canLaunch`](https://www.dartdocs.org/documentation/url_launcher/latest/url_launcher/canLaunch.html)
[`canLaunch`](https://pub.dev/documentation/url_launcher/latest/url_launcher/canLaunch.html)
method prior to calling `launch`. If the `canLaunch` method returns false, as a
best practice we suggest adjusting the application UI so that the unsupported
URL is never triggered; for example, if the `email` scheme is not supported, a
Expand Down
2 changes: 1 addition & 1 deletion packages/url_launcher/url_launcher_linux/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Demonstrates how to use the url_launcher plugin.
## Getting Started

For help getting started with Flutter, view our online
[documentation](http://flutter.io/).
[documentation](https://flutter.dev/).
4 changes: 2 additions & 2 deletions packages/video_player/video_player/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Video Player plugin for Flutter

[![pub package](https://img.shields.io/pub/v/video_player.svg)](https://pub.dartlang.org/packages/video_player)
[![pub package](https://img.shields.io/pub/v/video_player.svg)](https://pub.dev/packages/video_player)

A Flutter plugin for iOS, Android and Web for playing back video on a Widget surface.

Expand All @@ -12,7 +12,7 @@ A Flutter plugin for iOS, Android and Web for playing back video on a Widget sur

## Installation

First, add `video_player` as a [dependency in your pubspec.yaml file](https://flutter.io/using-packages/).
First, add `video_player` as a [dependency in your pubspec.yaml file](https://flutter.dev/using-packages/).

### iOS

Expand Down
4 changes: 2 additions & 2 deletions packages/webview_flutter/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# WebView for Flutter

[![pub package](https://img.shields.io/pub/v/webview_flutter.svg)](https://pub.dartlang.org/packages/webview_flutter)
[![pub package](https://img.shields.io/pub/v/webview_flutter.svg)](https://pub.dev/packages/webview_flutter)

A Flutter plugin that provides a WebView widget.

On iOS the WebView widget is backed by a [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview);
On Android the WebView widget is backed by a [WebView](https://developer.android.com/reference/android/webkit/WebView).

## Usage
Add `webview_flutter` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
Add `webview_flutter` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).

You can now include a WebView widget in your widget tree. See the
[WebView](https://pub.dev/documentation/webview_flutter/latest/webview_flutter/WebView-class.html)
Expand Down