Skip to content

Commit 98290c2

Browse files
authored
Migrate devtools wiki & update old flutter wiki links (#7875)
Part of flutter/flutter#145009 This migrates the home and triage page of the devtools wiki into checked in files, and updates all old references to flutter/flutter/wiki I'll update the original wiki pages to point to these new places after this lands ![build.yaml badge] If you need help, consider asking for help on [Discord]. [build.yaml badge]: https://github.com/flutter/devtools/actions/workflows/build.yaml/badge.svg
1 parent bea96fb commit 98290c2

File tree

11 files changed

+55
-17
lines changed

11 files changed

+55
-17
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ If you need help, consider asking for help on [Discord].
2121

2222
<!-- Links -->
2323
[Contributor Guide]: https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md
24-
[Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene
25-
[Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
24+
[Tree Hygiene]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md
25+
[Flutter Style Guide]: https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md
2626
[CLA]: https://cla.developers.google.com/
27-
[Discord]: https://github.com/flutter/flutter/wiki/Chat
27+
[Discord]: https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md
2828
[build.yaml badge]: https://github.com/flutter/devtools/actions/workflows/build.yaml/badge.svg

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
![GitHub contributors](https://img.shields.io/github/contributors/flutter/devtools.svg)
44

5-
_tl;dr: join [Discord](https://github.com/flutter/flutter/wiki/Chat), be
5+
_tl;dr: join [Discord](https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md), be
66
[courteous](https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md), follow the steps below
77
to set up a development environment; if you stick around and contribute, you can
8-
[join the team](https://github.com/flutter/flutter/wiki/Contributor-access) and get commit access._
8+
[join the team](https://github.com/flutter/flutter/blob/master/docs/contributing/Contributor-access.md) and get commit access._
99

1010
> If you are here because you just want to test the bleeding-edge (unreleased) DevTools functionality,
1111
follow our [beta testing guidance](https://github.com/flutter/devtools/blob/master/BETA_TESTING.md).
@@ -17,7 +17,7 @@ We gladly accept contributions via GitHub pull requests! We encourage you to rea
1717
framework's contributing guide, as all of that information applies to contributing to the `flutter/devtools`
1818
repo as well.
1919

20-
We communicate primarily over GitHub and [Discord](https://github.com/flutter/flutter/wiki/Chat) on the
20+
We communicate primarily over GitHub and [Discord](https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md) on the
2121
[#hackers-devtools](https://discord.com/channels/608014603317936148/1106667330093723668) channel.
2222

2323
Before contributing code:

STYLE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

77
## Order of getters and setters
88

@@ -11,19 +11,19 @@ more complicated than just public field
1111
we declare the related class members always in the same order,
1212
without new lines separating the members,
1313
in compliance with
14-
[Flutter repo style guide]( https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#order-other-class-members-in-a-way-that-makes-sense):
14+
[Flutter repo style guide](https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#order-other-class-members-in-a-way-that-makes-sense):
1515

1616
1. Public getter
1717
2. Private field
1818
3. Public setter (when needed)
1919

2020
## Naming for typedefs and function variables
2121

22-
Follow [Flutter repo naming rules for typedefs and function variables](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#naming-rules-for-typedefs-and-function-variables).
22+
Follow [Flutter repo naming rules for typedefs and function variables](https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#naming-rules-for-typedefs-and-function-variables).
2323

2424
## Overriding equality
2525

26-
Use [boilerplate](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#common-boilerplates-for-operator--and-hashcode).
26+
Use [boilerplate](https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#common-boilerplates-for-operator--and-hashcode).
2727

2828
## URIs and File Paths
2929

TRIAGE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Triage
2+
3+
## The Process
4+
5+
If you are the devtools triage rotation on-call, you are expected to triage issues that appeared/updated during the week (it is ok to triage all of them at the end of the week).
6+
7+
You are also expected to monitor the DevTools discord [channel](https://discord.com/channels/608014603317936148/958862085297672282) for user questions / concerns.
8+
9+
## DevTools Issues
10+
11+
Queue: https://github.com/flutter/devtools/issues?q=is%3Aopen+is%3Aissue+-label%3AP0%2CP1%2CP2%2CP3%2CP4%2CP5%2CP6
12+
13+
For each new issue that comes in, perform all of these tasks that apply:
14+
15+
### Label/project the issue:
16+
* Add labels for its proper category or categories ( “Inspector page”, “debugger page”, “bug”, etc.)
17+
* Add label “waiting for customer response” if you requested more details from reporter
18+
* Add label “fix it friday” if the issue should be fixed and looks easy to fix
19+
* Add to project [go/dart-devtools-ux-issues](https://github.com/orgs/flutter/projects/54/settings) if the issue is cross-screen issue
20+
21+
### Prioritize the issue.
22+
23+
Follow the prioritization rubric [here](https://github.com/flutter/flutter/blob/master/docs/contributing/issue_hygiene/README.md#priorities).
24+
25+
Tag the area owner in a comment if the issue requires specific expertise. Assign to an owner if the issue is a work in process or if the issue needs immediate / almost-immediate attention (P0, P1).
26+
27+
## Related Flutter Issues
28+
29+
flutter/flutter issues relating to DevTools:
30+
https://github.com/flutter/flutter/issues?q=is%3Aopen+label%3A%22d%3A+devtools%22+++no%3Amilestone+
31+
32+
Ping the [hackers-devtools](https://discord.com/channels/608014603317936148/1106667330093723668) discord channel about issues marked “severe: …” or “P0”.

docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Home
2+
3+
This wiki is primarily aimed at engineers building or making contributions to DevTools.
4+
5+
If you're looking to make a one-off contribution, please start with the [contributing guide](../CONTRIBUTING.md).

packages/analysis_options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ linter:
100100
- prefer_const_literals_to_create_immutables
101101
# - prefer_constructors_over_static_methods # not yet tested
102102
- prefer_contains
103-
# - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods
103+
# - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#consider-using--for-short-functions-and-methods
104104
- prefer_final_fields
105105
- prefer_final_in_for_each
106106
- prefer_final_locals

packages/devtools_app/lib/src/framework/about_dialog.dart

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,16 @@ class _ContributingLink extends StatelessWidget {
114114
class _DiscordLink extends StatelessWidget {
115115
const _DiscordLink();
116116

117-
static const _discordWikiUrl = 'https://github.com/flutter/flutter/wiki/Chat';
117+
static const _discordDocsUrl =
118+
'https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md';
118119

119120
@override
120121
Widget build(BuildContext context) {
121122
return RichText(
122123
text: GaLinkTextSpan(
123124
link: const GaLink(
124125
display: 'Discord',
125-
url: _discordWikiUrl,
126+
url: _discordDocsUrl,
126127
gaScreenName: gac.devToolsMain,
127128
gaSelectedItemDescription: gac.discordLink,
128129
),

packages/devtools_app/test/legacy_integration_tests/integration.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,7 @@ class WebBuildFixture {
423423
// directly to prevent Windows-based test runs getting killed but leaving
424424
// the pub process behind. Something similar might be needed here.
425425
// See here for more information:
426-
// https://github.com/flutter/flutter/wiki/The-flutter-tool#debugging-the-flutter-command-line-tool
426+
// https://github.com/flutter/flutter/blob/master/docs/tool/README.md#debugging-the-flutter-command-line-tool
427427
final executable = Platform.isWindows ? 'flutter.bat' : 'flutter';
428428

429429
if (verbose) {

packages/devtools_extensions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ popd
392392

393393
## Resources and support
394394

395-
Please join the [Flutter Discord server](https://github.com/flutter/flutter/wiki/Chat) and then check out
395+
Please join the [Flutter Discord server](https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md) and then check out
396396
the [#devtools-extension-authors](https://discord.com/channels/608014603317936148/1159561514072690739)
397397
channel to connect with other DevTools extension authors and the DevTools team.
398398

packages/devtools_shared/lib/src/test/chrome_driver.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class ChromeDriver with IOMixin {
1313

1414
// TODO(kenz): add error messaging if the chromedriver executable is not
1515
// found. We can also consider using web installers directly in this script:
16-
// https://github.com/flutter/flutter/wiki/Running-Flutter-Driver-tests-with-Web#web-installers-repo.
16+
// https://github.com/flutter/flutter/blob/master/docs/contributing/testing/Running-Flutter-Driver-tests-with-Web.md#web-installers-repo.
1717
Future<void> start({bool debugLogging = false}) async {
1818
try {
1919
if (debugLogging) {

0 commit comments

Comments
 (0)