Update flutter.dev links to more permanent destinations (#7953)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ebcb4f0..9a40bba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md
@@ -45,12 +45,12 @@ ### 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
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 165f44c..0dadcd6 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md
@@ -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.
diff --git a/README.md b/README.md index 88ccc8b..b2e4db9 100644 --- a/README.md +++ b/README.md
@@ -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
diff --git a/STYLE.md b/STYLE.md index 281fcf0..3c54b82 100644 --- a/STYLE.md +++ b/STYLE.md
@@ -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):
diff --git a/case_study/code_size/optimized/code_size_images/android/.gitignore b/case_study/code_size/optimized/code_size_images/android/.gitignore index 0a741cb..8e599af 100644 --- a/case_study/code_size/optimized/code_size_images/android/.gitignore +++ b/case_study/code_size/optimized/code_size_images/android/.gitignore
@@ -7,5 +7,5 @@ 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
diff --git a/case_study/code_size/optimized/code_size_package/android/.gitignore b/case_study/code_size/optimized/code_size_package/android/.gitignore index 0a741cb..8e599af 100644 --- a/case_study/code_size/optimized/code_size_package/android/.gitignore +++ b/case_study/code_size/optimized/code_size_package/android/.gitignore
@@ -7,5 +7,5 @@ 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
diff --git a/case_study/code_size/unoptimized/code_size_images/android/.gitignore b/case_study/code_size/unoptimized/code_size_images/android/.gitignore index 0a741cb..8e599af 100644 --- a/case_study/code_size/unoptimized/code_size_images/android/.gitignore +++ b/case_study/code_size/unoptimized/code_size_images/android/.gitignore
@@ -7,5 +7,5 @@ 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
diff --git a/case_study/code_size/unoptimized/code_size_package/android/.gitignore b/case_study/code_size/unoptimized/code_size_package/android/.gitignore index 0a741cb..8e599af 100644 --- a/case_study/code_size/unoptimized/code_size_package/android/.gitignore +++ b/case_study/code_size/unoptimized/code_size_package/android/.gitignore
@@ -7,5 +7,5 @@ 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
diff --git a/case_study/memory_leaks/images_1/android/.gitignore b/case_study/memory_leaks/images_1/android/.gitignore index 6f56801..55afd91 100644 --- a/case_study/memory_leaks/images_1/android/.gitignore +++ b/case_study/memory_leaks/images_1/android/.gitignore
@@ -7,7 +7,7 @@ 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
diff --git a/case_study/memory_leaks/leaking_counter_1/android/.gitignore b/case_study/memory_leaks/leaking_counter_1/android/.gitignore index 6f56801..55afd91 100644 --- a/case_study/memory_leaks/leaking_counter_1/android/.gitignore +++ b/case_study/memory_leaks/leaking_counter_1/android/.gitignore
@@ -7,7 +7,7 @@ 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
diff --git a/case_study/memory_leaks/leaking_counter_1/android/app/build.gradle b/case_study/memory_leaks/leaking_counter_1/android/app/build.gradle index 8011820..c0d4109 100644 --- a/case_study/memory_leaks/leaking_counter_1/android/app/build.gradle +++ b/case_study/memory_leaks/leaking_counter_1/android/app/build.gradle
@@ -46,7 +46,7 @@ // 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()
diff --git a/packages/devtools_app/README.md b/packages/devtools_app/README.md index 4138425..d875079 100644 --- a/packages/devtools_app/README.md +++ b/packages/devtools_app/README.md
@@ -6,8 +6,8 @@ ## 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
diff --git a/packages/devtools_app/integration_test/README.md b/packages/devtools_app/integration_test/README.md index 677afc7..fdb9abd 100644 --- a/packages/devtools_app/integration_test/README.md +++ b/packages/devtools_app/integration_test/README.md
@@ -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`:
diff --git a/packages/devtools_app/lib/src/screens/deep_link_validation/deep_links_screen.dart b/packages/devtools_app/lib/src/screens/deep_link_validation/deep_links_screen.dart index 87105a8..4bc9d13 100644 --- a/packages/devtools_app/lib/src/screens/deep_link_validation/deep_links_screen.dart +++ b/packages/devtools_app/lib/src/screens/deep_link_validation/deep_links_screen.dart
@@ -22,11 +22,8 @@ // @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) {
diff --git a/packages/devtools_app/lib/src/screens/memory/panes/diff/diff_pane.dart b/packages/devtools_app/lib/src/screens/memory/panes/diff/diff_pane.dart index 583cdba..bf84db4 100644 --- a/packages/devtools_app/lib/src/screens/memory/panes/diff/diff_pane.dart +++ b/packages/devtools_app/lib/src/screens/memory/panes/diff/diff_pane.dart
@@ -148,7 +148,7 @@ \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
diff --git a/packages/devtools_app/lib/src/screens/memory/panes/profile/ALLOCATION_PROFILE.md b/packages/devtools_app/lib/src/screens/memory/panes/profile/ALLOCATION_PROFILE.md index d8f6072..681bc94 100644 --- a/packages/devtools_app/lib/src/screens/memory/panes/profile/ALLOCATION_PROFILE.md +++ b/packages/devtools_app/lib/src/screens/memory/panes/profile/ALLOCATION_PROFILE.md
@@ -1 +1 @@ -Documentation: https://docs.flutter.dev/development/tools/devtools/memory#profile-tab \ No newline at end of file +Documentation: https://docs.flutter.dev/tools/devtools/memory#profile-memory-tab \ No newline at end of file
diff --git a/packages/devtools_app/lib/src/screens/memory/panes/tracing/ALLOCATION_TRACING.md b/packages/devtools_app/lib/src/screens/memory/panes/tracing/ALLOCATION_TRACING.md index 4454490..ee77773 100644 --- a/packages/devtools_app/lib/src/screens/memory/panes/tracing/ALLOCATION_TRACING.md +++ b/packages/devtools_app/lib/src/screens/memory/panes/tracing/ALLOCATION_TRACING.md
@@ -1 +1 @@ -Documentation: https://docs.flutter.dev/development/tools/devtools/memory#trace-tab \ No newline at end of file +Documentation: https://docs.flutter.dev/tools/devtools/memory#trace-instances-tab \ No newline at end of file
diff --git a/packages/devtools_app/lib/src/screens/performance/panes/frame_analysis/frame_hints.dart b/packages/devtools_app/lib/src/screens/performance/panes/frame_analysis/frame_hints.dart index 1381f07..0df3fa5 100644 --- a/packages/devtools_app/lib/src/screens/performance/panes/frame_analysis/frame_hints.dart +++ b/packages/devtools_app/lib/src/screens/performance/panes/frame_analysis/frame_hints.dart
@@ -250,7 +250,7 @@ }); 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; @@ -293,8 +293,7 @@ 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;
diff --git a/packages/devtools_app/lib/src/screens/performance/performance_screen.dart b/packages/devtools_app/lib/src/screens/performance/performance_screen.dart index f1f9129..98a119b 100644 --- a/packages/devtools_app/lib/src/screens/performance/performance_screen.dart +++ b/packages/devtools_app/lib/src/screens/performance/performance_screen.dart
@@ -174,7 +174,7 @@ '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';
diff --git a/packages/devtools_app/lib/src/screens/performance/performance_utils.dart b/packages/devtools_app/lib/src/screens/performance/performance_utils.dart index 11d1e97..87639f0 100644 --- a/packages/devtools_app/lib/src/screens/performance/performance_utils.dart +++ b/packages/devtools_app/lib/src/screens/performance/performance_utils.dart
@@ -6,7 +6,7 @@ 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(
diff --git a/packages/devtools_app/lib/src/service/service_extensions.dart b/packages/devtools_app/lib/src/service/service_extensions.dart index 84bef0f..a056d3a 100644 --- a/packages/devtools_app/lib/src/service/service_extensions.dart +++ b/packages/devtools_app/lib/src/service/service_extensions.dart
@@ -227,7 +227,7 @@ 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, ); @@ -239,7 +239,7 @@ 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, ); @@ -252,7 +252,7 @@ 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, ); @@ -263,8 +263,7 @@ 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, ); @@ -277,7 +276,7 @@ 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, ); @@ -303,7 +302,7 @@ 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, ); @@ -317,7 +316,7 @@ 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, ); @@ -330,7 +329,7 @@ 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, ); @@ -342,7 +341,7 @@ 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, ); @@ -373,7 +372,7 @@ 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, ); @@ -388,7 +387,7 @@ 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, ); @@ -405,7 +404,7 @@ 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, ); @@ -501,7 +500,6 @@ '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, );
diff --git a/packages/devtools_app/lib/src/shared/banner_messages.dart b/packages/devtools_app/lib/src/shared/banner_messages.dart index d9d6ac3..e3f3cb0 100644 --- a/packages/devtools_app/lib/src/shared/banner_messages.dart +++ b/packages/devtools_app/lib/src/shared/banner_messages.dart
@@ -18,11 +18,10 @@ 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>>{};
diff --git a/packages/devtools_app/lib/src/shared/console/widgets/help_dialog.dart b/packages/devtools_app/lib/src/shared/console/widgets/help_dialog.dart index 7823356..5b9d102 100644 --- a/packages/devtools_app/lib/src/shared/console/widgets/help_dialog.dart +++ b/packages/devtools_app/lib/src/shared/console/widgets/help_dialog.dart
@@ -49,7 +49,7 @@ ), 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),
diff --git a/packages/devtools_app/lib/src/shared/primitives/simple_items.dart b/packages/devtools_app/lib/src/shared/primitives/simple_items.dart index ceaebb6..8e6e5c5 100644 --- a/packages/devtools_app/lib/src/shared/primitives/simple_items.dart +++ b/packages/devtools_app/lib/src/shared/primitives/simple_items.dart
@@ -29,10 +29,8 @@ 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.
diff --git a/packages/devtools_app_shared/README.md b/packages/devtools_app_shared/README.md index 95675b4..bced4fc 100644 --- a/packages/devtools_app_shared/README.md +++ b/packages/devtools_app_shared/README.md
@@ -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.
diff --git a/packages/devtools_extensions/README.md b/packages/devtools_extensions/README.md index 4e522c8..397385d 100644 --- a/packages/devtools_extensions/README.md +++ b/packages/devtools_extensions/README.md
@@ -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.).
diff --git a/packages/devtools_test/README.md b/packages/devtools_test/README.md index 52e8174..cec1c3f 100644 --- a/packages/devtools_test/README.md +++ b/packages/devtools_test/README.md
@@ -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.