Skip to content

Commit

Permalink
Update flutter.dev links to more permanent destinations (#7953)
Browse files Browse the repository at this point in the history
  • Loading branch information
parlough authored Jun 21, 2024
1 parent a566b22 commit c2267ca
Show file tree
Hide file tree
Showing 27 changed files with 48 additions and 56 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ You can do this online, and it only takes a minute.
### Set up your DevTools environment

**Before setting up your DevTools environment**, please make sure you have
[cloned the Flutter SDK from GitHub](https://docs.flutter.dev/get-started/install/macos#downloading-straight-from-github-instead-of-using-an-archive)
[cloned the Flutter SDK from GitHub](https://github.com/flutter/flutter/blob/main/docs/contributing/Setting-up-the-Framework-development-environment.md)
and added the included `flutter` and `dart` executables to your `PATH` environment variable (see Flutter
instructions for how to [update your PATH](https://docs.flutter.dev/get-started/install/macos#update-your-path)).
instructions for how to [update your PATH](https://flutter.dev/to/update-macos-path)).

Typing `which flutter` and `which dart` (or `where.exe flutter` and `where.exe dart` for Windows)
into your terminal should print the path to the binaries from Flutter SDK you cloned from Github.
into your terminal should print the path to the binaries from Flutter SDK you cloned from GitHub.

1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the DevTools repo to your
own Github account, and then clone it using SSH. If you haven't already, you may need to
Expand Down
5 changes: 3 additions & 2 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
## DevTools Documentation - How To Guide
The documentation for Dart & Flutter DevTools lives on [flutter.dev](https://docs.flutter.dev/development/tools/devtools/overview).

Our docs are written and pushed up to the [flutter/website](https://docs.flutter.dev/development/tools/devtools/overview)
The documentation for Dart & Flutter DevTools lives on [flutter.dev](https://docs.flutter.dev/tools/devtools).

Our docs are written and pushed up to the [flutter/website](https://docs.flutter.dev/tools/devtools)
repo by the Flutter DevRel team. Developers working on DevTools should collaborate with Flutter tech writers by following
the below workflow.

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

## What is this?

[Dart & Flutter DevTools](https://flutter.dev/docs/development/tools/devtools/) is a suite of performance tools for Dart and Flutter.
[Dart & Flutter DevTools](https://docs.flutter.dev/tools/devtools) is a suite of performance tools for Dart and Flutter.

## Getting started

For documentation on installing and trying out DevTools, please see our
[docs](https://flutter.dev/docs/development/tools/devtools/).
[docs](https://docs.flutter.dev/tools/devtools).

## Contributing and development

Expand Down
2 changes: 1 addition & 1 deletion STYLE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DevTools style guide

We fully follow [Effective Dart](https://dart.dev/guides/language/effective-dart)
We fully follow [Effective Dart](https://dart.dev/effective-dart)
and some items of
[Style guide for Flutter repo](https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ gradle-wrapper.jar
GeneratedPluginRegistrant.java

# Remember to never publicly share your keystore.
# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
# See https://flutter.dev/to/reference-keystore
key.properties
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ gradle-wrapper.jar
GeneratedPluginRegistrant.java

# Remember to never publicly share your keystore.
# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
# See https://flutter.dev/to/reference-keystore
key.properties
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ gradle-wrapper.jar
GeneratedPluginRegistrant.java

# Remember to never publicly share your keystore.
# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
# See https://flutter.dev/to/reference-keystore
key.properties
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ gradle-wrapper.jar
GeneratedPluginRegistrant.java

# Remember to never publicly share your keystore.
# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
# See https://flutter.dev/to/reference-keystore
key.properties
2 changes: 1 addition & 1 deletion case_study/memory_leaks/images_1/android/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ gradle-wrapper.jar
GeneratedPluginRegistrant.java

# Remember to never publicly share your keystore.
# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
# See https://flutter.dev/to/reference-keystore
key.properties
**/*.keystore
**/*.jks
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ gradle-wrapper.jar
GeneratedPluginRegistrant.java

# Remember to never publicly share your keystore.
# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
# See https://flutter.dev/to/reference-keystore
key.properties
**/*.keystore
**/*.jks
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ android {
// TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
applicationId "com.example.leaking_counter_1"
// You can update the following values to match your application needs.
// For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-build-configuration.
// For more information, see: https://flutter.dev/to/review-gradle-config.
minSdkVersion flutter.minSdkVersion
targetSdkVersion flutter.targetSdkVersion
versionCode flutterVersionCode.toInteger()
Expand Down
4 changes: 2 additions & 2 deletions packages/devtools_app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ the devtools app is in package:devtools_app.

## Getting started

For documentation on installing and trying out DevTools, please see our
[docs](https://flutter.dev/docs/development/tools/devtools/).
For documentation on installing and trying out DevTools, please
visit the [DevTools docs](https://docs.flutter.dev/tools/devtools/).

## Feedback

Expand Down
2 changes: 1 addition & 1 deletion packages/devtools_app/integration_test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Set up ChromeDriver (one time only)

1. Follow the instructions [here](https://docs.flutter.dev/cookbook/testing/integration/introduction#5b-web) to download ChromeDriver.
1. Follow the instructions [here](https://flutter.dev/to/integration-test-on-web) to download ChromeDriver.

2. Add `chromedriver` to your PATH by modifying your `.bash_profile` or `.zshrc`:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,8 @@ class DeepLinksScreen extends Screen {
// @override
// String get docPageId => id;

// TODO(https://github.com/flutter/devtools/issues/6013): consider removing
// this docs url override when documentation is written specifically for the
// deep links tool.
@override
String get docsUrl => 'https://docs.flutter.dev/ui/navigation/deep-linking';
String get docsUrl => 'https://flutter.dev/to/deep-link-tool';

@override
Widget buildScreenBody(BuildContext context) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Find unexpected memory usage by comparing two heap snapshots:
\v
1. Understand [Dart memory concepts](https://docs.flutter.dev/development/tools/devtools/memory#basic-memory-concepts).
1. Understand [Dart memory concepts](https://docs.flutter.dev/tools/devtools/memory#basic-memory-concepts).
\v
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Documentation: https://docs.flutter.dev/development/tools/devtools/memory#profile-tab
Documentation: https://docs.flutter.dev/tools/devtools/memory#profile-memory-tab
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Documentation: https://docs.flutter.dev/development/tools/devtools/memory#trace-tab
Documentation: https://docs.flutter.dev/tools/devtools/memory#trace-instances-tab
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ class IntrinsicOperationsHint extends StatelessWidget {
});

static const _intrinsicOperationsDocs =
'https://docs.flutter.dev/perf/best-practices#minimize-layout-passes-caused-by-intrinsic-operations';
'https://flutter.dev/to/minimize-layout-passes';

final int intrinsicOperationsCount;

Expand Down Expand Up @@ -293,8 +293,7 @@ class CanvasSaveLayerHint extends StatelessWidget {
super.key,
});

static const _saveLayerDocs =
'https://docs.flutter.dev/perf/best-practices#use-savelayer-thoughtfully';
static const _saveLayerDocs = 'https://flutter.dev/to/save-layer-perf';

final int saveLayerCount;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ const debugLayoutsLink =
'https://api.flutter.dev/flutter/rendering/debugProfileLayoutsEnabled.html';
const debugPaintsLink =
'https://api.flutter.dev/flutter/rendering/debugProfilePaintsEnabled.html';
const profileModeLink = 'https://docs.flutter.dev/testing/build-modes#profile';
const profileModeLink = 'https://flutter.dev/to/profile-mode';
const performancePanelLink =
'https://developer.chrome.com/docs/devtools/performance';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import '../../shared/globals.dart';

const preCompileShadersDocsUrl = 'https://docs.flutter.dev/perf/shader';

const impellerDocsUrl = 'https://docs.flutter.dev/perf/impeller';
const impellerDocsUrl = 'https://flutter.dev/to/impeller';

void pushNoTimelineEventsAvailableWarning() {
notificationService.push(
Expand Down
28 changes: 13 additions & 15 deletions packages/devtools_app/lib/src/service/service_extensions.dart
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ final invertOversizedImages = ToggleableServiceExtensionDescription<bool>.from(
tooltip:
'Highlight images that are using too much memory by inverting colors and flipping them.',
documentationUrl:
'https://flutter.dev/docs/development/tools/devtools/inspector#highlight-oversized-images',
'https://docs.flutter.dev/tools/devtools/inspector#highlight-oversized-images',
gaDocsItem: gac.highlightOversizedImagesDocs,
);

Expand All @@ -239,7 +239,7 @@ final debugPaint = ToggleableServiceExtensionDescription<bool>.from(
gaItem: gac.debugPaint,
tooltip: 'Overlay guidelines to assist with fixing layout issues.',
documentationUrl:
'https://flutter.dev/docs/development/tools/devtools/inspector#show-guidelines',
'https://docs.flutter.dev/tools/devtools/inspector#show-guidelines',
gaDocsItem: gac.debugPaintDocs,
);

Expand All @@ -252,7 +252,7 @@ final debugPaintBaselines = ToggleableServiceExtensionDescription<bool>.from(
tooltip:
'Show baselines, which are used to position text. Can be useful for checking if text is aligned.',
documentationUrl:
'https://flutter.dev/docs/development/tools/devtools/inspector#show-baselines',
'https://docs.flutter.dev/tools/devtools/inspector#show-baselines',
gaDocsItem: gac.paintBaselineDocs,
);

Expand All @@ -263,8 +263,7 @@ final performanceOverlay = ToggleableServiceExtensionDescription<bool>.from(
gaScreenName: gac.performance,
gaItem: gac.PerformanceEvents.performanceOverlay.name,
tooltip: 'Overlay a performance chart on your app.',
documentationUrl:
'https://flutter.dev/docs/perf/rendering/ui-performance#the-performance-overlay',
documentationUrl: 'https://flutter.dev/to/performance-overlay',
gaDocsItem: gac.PerformanceDocs.performanceOverlayDocs.name,
);

Expand All @@ -277,7 +276,7 @@ final profileWidgetBuilds = ToggleableServiceExtensionDescription<bool>.from(
description: 'Adds an event to the timeline for every Widget built.',
tooltip: '',
documentationUrl:
'https://docs.flutter.dev/development/tools/devtools/performance#track-widget-builds',
'https://docs.flutter.dev/tools/devtools/performance#track-widget-builds',
gaDocsItem: gac.PerformanceDocs.trackWidgetBuildsDocs.name,
);

Expand All @@ -303,7 +302,7 @@ final profileRenderObjectPaints =
description: 'Adds an event to the timeline for every RenderObject painted.',
tooltip: '',
documentationUrl:
'https://docs.flutter.dev/development/tools/devtools/performance#track-paints',
'https://docs.flutter.dev/tools/devtools/performance#track-paints',
gaDocsItem: gac.PerformanceDocs.trackPaintsDocs.name,
);

Expand All @@ -317,7 +316,7 @@ final profileRenderObjectLayouts =
description: 'Adds an event to the timeline for every RenderObject layout.',
tooltip: '',
documentationUrl:
'https://docs.flutter.dev/development/tools/devtools/performance#track-layouts',
'https://docs.flutter.dev/tools/devtools/performance#track-layouts',
gaDocsItem: gac.PerformanceDocs.trackLayoutsDocs.name,
);

Expand All @@ -330,7 +329,7 @@ final repaintRainbow = ToggleableServiceExtensionDescription<bool>.from(
tooltip:
'Show borders that change color when elements repaint. Useful for finding unnecessary repaints.',
documentationUrl:
'https://flutter.dev/docs/development/tools/devtools/inspector#highlight-repaints',
'https://docs.flutter.dev/tools/devtools/inspector#highlight-repaints',
gaDocsItem: gac.repaintRainbowDocs,
);

Expand All @@ -342,7 +341,7 @@ final slowAnimations = ToggleableServiceExtensionDescription<num>.from(
gaItem: gac.slowAnimation,
tooltip: 'Run animations 5 times slower to help fine-tune them.',
documentationUrl:
'https://flutter.dev/docs/development/tools/devtools/inspector#slow-animations',
'https://docs.flutter.dev/tools/devtools/inspector#slow-animations',
gaDocsItem: gac.slowAnimationDocs,
);

Expand Down Expand Up @@ -373,7 +372,7 @@ final disableClipLayers = ToggleableServiceExtensionDescription<bool>.from(
affecting performance. If performance improves with this option
disabled, try to reduce the use of clipping effects in your app.''',
documentationUrl:
'https://docs.flutter.dev/development/tools/devtools/performance#more-debugging-options',
'https://docs.flutter.dev/tools/devtools/performance#more-debugging-options',
gaDocsItem: gac.PerformanceDocs.disableClipLayersDocs.name,
);

Expand All @@ -388,7 +387,7 @@ final disableOpacityLayers = ToggleableServiceExtensionDescription<bool>.from(
effects is affecting performance. If performance improves with this
option disabled, try to reduce the use of opacity effects in your app.''',
documentationUrl:
'https://docs.flutter.dev/development/tools/devtools/performance#more-debugging-options',
'https://docs.flutter.dev/tools/devtools/performance#more-debugging-options',
gaDocsItem: gac.PerformanceDocs.disableOpacityLayersDocs.name,
);

Expand All @@ -405,7 +404,7 @@ modeling effects is affecting performance (shadows, elevations, etc.).
If performance improves with this option disabled, try to reduce the
use of physical modeling effects in your app.''',
documentationUrl:
'https://docs.flutter.dev/development/tools/devtools/performance#more-debugging-options',
'https://docs.flutter.dev/tools/devtools/performance#more-debugging-options',
gaDocsItem: gac.PerformanceDocs.disablePhysicalShapeLayersDocs.name,
);

Expand Down Expand Up @@ -501,7 +500,6 @@ final profilePlatformChannels =
'apps with plugins). Also periodically prints platform channel '
'statistics to console.',
tooltip: '',
documentationUrl:
'https://docs.flutter.dev/platform-integration/platform-channels',
documentationUrl: 'https://flutter.dev/to/platform-channels',
gaDocsItem: gac.PerformanceDocs.platformChannelsDocs.name,
);
5 changes: 2 additions & 3 deletions packages/devtools_app/lib/src/shared/banner_messages.dart
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,10 @@ import 'http/http_service.dart' as http_service;
import 'primitives/utils.dart';
import 'screen.dart';

const _runInProfileModeDocsUrl =
'https://flutter.dev/docs/testing/ui-performance#run-in-profile-mode';
const _runInProfileModeDocsUrl = 'https://flutter.dev/to/use-profile-mode';

const _cpuSamplingRateDocsUrl =
'https://flutter.dev/docs/development/tools/devtools/performance#profile-granularity';
'https://docs.flutter.dev/tools/devtools/cpu-profiler#cpu-sampling-rate';

class BannerMessagesController {
final _messages = <String, ListValueNotifier<BannerMessage>>{};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Example: ''',
),
MoreInfoLink(
// TODO(polina-c): create content and change url.
url: 'https://docs.flutter.dev/development/tools/devtools/console',
url: 'https://docs.flutter.dev/tools/devtools/console',
gaScreenName: gac.console,
gaSelectedItemDescription:
gac.topicDocumentationLink(_documentationTopic),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,8 @@ const closureName = '<closure>';

const anonymousClosureName = '<anonymous closure>';

const _memoryDocUrl =
'https://docs.flutter.dev/development/tools/devtools/memory';
const _consoleDocUrl =
'https://docs.flutter.dev/development/tools/devtools/console';
const _memoryDocUrl = 'https://docs.flutter.dev/tools/devtools/memory';
const _consoleDocUrl = 'https://docs.flutter.dev/tools/devtools/console';
const _inspectorDocUrl = 'https://docs.flutter.dev/tools/devtools/inspector';

/// Some links to documentation.
Expand Down
2 changes: 1 addition & 1 deletion packages/devtools_app_shared/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Shared DevTools Components

This package contains UI, utility, and service components from
[Dart & Flutter DevTools](https://docs.flutter.dev/tools/devtools/overview) that can
[Dart & Flutter DevTools](https://docs.flutter.dev/tools/devtools) that can
be shared between DevTools, DevTools extensions, and other tooling surfaces that need
the same logic or styling.

Expand Down
2 changes: 1 addition & 1 deletion packages/devtools_extensions/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Dart & Flutter DevTools Extensions

Extend Dart & Flutter's developer tool suite,
[Dart DevTools](https://docs.flutter.dev/tools/devtools/overview), with your own custom tool.
[Dart DevTools](https://docs.flutter.dev/tools/devtools), with your own custom tool.
DevTools' extension framework allows you to build tools that can leverage existing frameworks
and utilities from DevTools (VM service connection, theming, shared widgets, utilities, etc.).

Expand Down
2 changes: 1 addition & 1 deletion packages/devtools_test/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## What is this?

This is a package containing test utilities for use when writing [Dart DevTools](https://docs.flutter.dev/development/tools/devtools/overview) tests.
This is a package containing test utilities for use when writing [Dart DevTools](https://docs.flutter.dev/development/tools/devtools) tests.

The package is separate from devtools_app, because it is used in g3.

Expand Down

0 comments on commit c2267ca

Please sign in to comment.