[wiki migration] Remaining pages under docs/contributing/ (#148790)

flutter · May 23, 2024 · 65abc95 · 65abc95
1 parent de0fbde
commit 65abc95
Show file tree

Hide file tree

Showing 21 changed files with 153 additions and 172 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -163,6 163,7 @@ team:
  - changed-files:
  - any-glob-to-any-file:
  - docs/about/**/*
  - docs/contributing/**/*
  - docs/postmortems/**/*
 
 team-android:

diff --git a/dev/bots/analyze.dart b/dev/bots/analyze.dart
@@ -1314,6 1314,7 @@ Future<void> verifyRepositoryLinks(String workingDirectory) async {
  'flutter/flutter_gallery_assets', // TODO(guidezpl): remove when subtask in https://github.com/flutter/flutter/issues/121564 is complete
  'flutter/flutter-intellij', // TODO(guidezpl): remove when https://github.com/flutter/flutter-intellij/issues/7342 is closed
  'flutter/platform_tests', // TODO(guidezpl): remove when subtask in https://github.com/flutter/flutter/issues/121564 is complete
  'flutter/web_installers',
  'glfw/glfw',
  'GoogleCloudPlatform/artifact-registry-maven-tools',
  'material-components/material-components-android', // TODO(guidezpl): remove when https://github.com/material-components/material-components-android/issues/4144 is closed

diff --git a/docs/unsorted_wiki/Chat.md → docs/contributing/Chat.md b/docs/unsorted_wiki/Chat.md → docs/contributing/Chat.md
@@ -49,11 49,11 @@ Each channel describes its topic in the channel description. Please read the cha
 
 ## Policies
 
-Our [code of conduct](https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md) applies to the Discord server, as it does to any communications involving Flutter.
 Our [code of conduct](https://github.com/flutter/flutter/blob/main/CODE_OF_CONDUCT.md) applies to the Discord server, as it does to any communications involving Flutter.
 
-The #hackers-* channels are visible to anyone, but please only post in those channels if you are actively contributing. If you want help with your app, ask in #help instead. If you want to learn how to contribute, have a look at our [contributing guide](https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md).
 The #hackers-* channels are visible to anyone, but please only post in those channels if you are actively contributing. If you want help with your app, ask in #help instead. If you want to learn how to contribute, have a look at our [contributing guide](https://github.com/flutter/flutter/blob/main/CONTRIBUTING.md).
 
-See the [[contributor access]] wiki page for details on becoming a member of the "team" role.
 See the [contributor access](Contributor-access.md) wiki page for details on becoming a member of the "team" role.
 
 Please don't direct-message people unless they are comfortable with it (ask publicly first).
 You can disable direct messages on this server by changing your Privacy settings for the server, or on a global basis by changing your Privacy & Safety user settings.
@@ -71,4 71,4 @@ You can [change your status](https://support.discord.com/hc/en-us/articles/36003
 
 # Design documents
 
-This page used to discuss how to create design docs, but that content is now on its own page: [[Design documents]].
 This page used to discuss how to create design docs, but that content is now on its own page: [Design documents](Design-Documents.md).
diff --git a/docs/unsorted_wiki/Contributor-access.md → docs/contributing/Contributor-access.md b/docs/unsorted_wiki/Contributor-access.md → docs/contributing/Contributor-access.md
@@ -2,29 2,29 @@ For people who make the occasional contribution to Flutter (filing an issue, sub
 
 We grant commit access (which includes full rights to the issue database, such as being able to edit labels, and grants access to our internal chat channels) to people who have gained our trust and demonstrated a commitment to Flutter.
 
-Specifically, if you meet one of the following criteria and you have a sponsor (someone who already has contributor access and agrees that you should be granted access), then please ask your sponsor to propose, on the #server-support [[chat]] channel, that you be made a member of the team, and then reply to that message explaining which criteria below you are claiming to meet. The possible criteria are:
 Specifically, if you meet one of the following criteria and you have a sponsor (someone who already has contributor access and agrees that you should be granted access), then please ask your sponsor to propose, on the #server-support [Chat](Chat.md) channel, that you be made a member of the team, and then reply to that message explaining which criteria below you are claiming to meet. The possible criteria are:
 
-* You have a long history of participating productively, e.g. in our [[chat]] channels, helping with [[Triage]], helping other contributors track down problems, finding meaningful issues in submitted PRs, helping people in our #help channel, etc, all while demonstrating exemplary behavior that closely aligns with our [code of conduct](https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md).
 * You have a long history of participating productively, e.g. in our [Chat](Chat.md) channels, helping with [Triage](https://github.com/flutter/flutter/wiki/Triage), helping other contributors track down problems, finding meaningful issues in submitted PRs, helping people in our #help channel, etc, all while demonstrating exemplary behavior that closely aligns with our [code of conduct](https://github.com/flutter/flutter/blob/main/CODE_OF_CONDUCT.md).
 * You have recently submitted several PRs that have landed successfully (received an LGTM, PR was merged, no regressions reported, PR was not reverted), without needing extensive tutoring in the process.
 * You are employed by a company with a history of contributing to Flutter, for the purpose of yourself regularly contributing to Flutter.
-* You represent a development team that creates applications, plugins, or packages using Flutter and have a close relationship with our developer relations team, including having a customer label, and have a great need to regularly update labels on issues (see [Issue hygiene, Customers](https://github.com/flutter/flutter/wiki/Issue-hygiene#customers)). (This is rare.)
 * You represent a development team that creates applications, plugins, or packages using Flutter and have a close relationship with our developer relations team, including having a customer label, and have a great need to regularly update labels on issues (see [Issue hygiene, Customers](./issue_hygiene/README.md#customers)). (This is rare.)
 
-Being granted access means that you will be added to the "flutter-hackers" group on GitHub and the "team" role on Discord. This privilege is granted with some expectation of responsibility: contributors are people who care about Flutter and want to help Flutter along our [[roadmap]]. A contributor is not just someone who can make changes or comment on issues, but someone who has demonstrated their ability to collaborate with the team, get the most knowledgeable people to review code, contribute high-quality code, follow through to fix bugs (in code or tests), and provide meaningful insights on issues.
 Being granted access means that you will be added to the "flutter-hackers" group on GitHub and the "team" role on Discord. This privilege is granted with some expectation of responsibility: contributors are people who care about Flutter and want to help Flutter along our [roadmap](https://github.com/flutter/flutter/wiki/Roadmap). A contributor is not just someone who can make changes or comment on issues, but someone who has demonstrated their ability to collaborate with the team, get the most knowledgeable people to review code, contribute high-quality code, follow through to fix bugs (in code or tests), and provide meaningful insights on issues.
 
-We grant access optimistically based on a reasonably small volume of evidence of good faith. Correspondingly, we will remove access quickly if we find our trust has been violated. Contributors with commit access must still follow all our processes and policies, and must follow our [code of conduct](https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md) rigorously. (Please read it, it's stricter than most.)
 We grant access optimistically based on a reasonably small volume of evidence of good faith. Correspondingly, we will remove access quickly if we find our trust has been violated. Contributors with commit access must still follow all our processes and policies, and must follow our [code of conduct](https://github.com/flutter/flutter/blob/main/CODE_OF_CONDUCT.md) rigorously. (Please read it, it's stricter than most.)
 
 
 ### Responsibilities
 
 #### Code of conduct
 
-If you have commit access or "team" access on the Discord server, you are responsible for enforcing our [code of conduct](https://github.com/flutter/flutter/blob/master/CODE_OF_CONDUCT.md).
 If you have commit access or "team" access on the Discord server, you are responsible for enforcing our [code of conduct](https://github.com/flutter/flutter/blob/main/CODE_OF_CONDUCT.md).
 
 Our code of conduct is much, much stricter than most. We do not wait until someone has been actively rude or insulting. Being disrespectful in any way is grounds for action. For example, passive-aggressive whining and general unconstructive negativity are all violations of the code of conduct. If someone is in a bad mood, we would rather they avoided contributing to Flutter on that day.
 
 When you see something that might be described as unwelcoming or is in some other way a violation of our code of conduct, promptly contact the offender and ask them to read the code of conduct and consider how they might more effectively espouse its philosophy. Most people react very positively to this.
 
-If they react negatively, or if they continue to make the environment unpleasant, they should be removed from the environment. On Discord, this would be kicking them from the channel. Repeat offenders should be banned. On GitHub, they can be blocked from our organisation (you may need to ask @Hixie or another admin of our GitHub org to do this). Please let the #server-support [[chat]] channel know when you do anything like this, so that we can keep an eye on how common it is.
 If they react negatively, or if they continue to make the environment unpleasant, they should be removed from the environment. On Discord, this would be kicking them from the channel. Repeat offenders should be banned. On GitHub, they can be blocked from our organisation (you may need to ask @Hixie or another admin of our GitHub org to do this). Please let the #server-support [Chat](Chat.md) channel know when you do anything like this, so that we can keep an eye on how common it is.
 
 #### Maintaining documentation
 
@@ -36,9 36,9 @@ For the wiki specifically, since there's no code review, it's good to mention on
 
 Being in the GitHub "flutter-hackers" group gives you the following:
 
-* The ability to merge your own PRs once they are reviewed (see [[Tree Hygiene]]).
 * The ability to merge your own PRs once they are reviewed (see [Tree Hygiene](Tree-hygiene.md)).
 
-* The ability to add labels, milestones, etc, on issues on GitHub (see [[Issue Hygiene]]).
 * The ability to add labels, milestones, etc, on issues on GitHub (see [Issue Hygiene](./issue_hygiene/README.md)).
 
 * PRs will run their tests slightly faster.
 
@@ -69,7 69,7 @@ The actual process (as followed by Flutter repo admins) is as follows:
 
 We occasionally check for account with commit access that have not been used for a while. It takes very little to count as "active" (e.g. commenting on an issue, even adding an emoji reaction to an issue). If your account has been inactive for over a year we will try to reach out (e.g. by e-mail or on Discord) before removing access.
 
-If your account access was removed but you wish to return to contributing to Flutter, you are most welcome to do so; just reach out on the Discord (see [[Chat]]) and ask someone to renominate you according to the process described above.
 If your account access was removed but you wish to return to contributing to Flutter, you are most welcome to do so; just reach out on the Discord (see [Chat](Chat.md)) and ask someone to renominate you according to the process described above.
 
 
 # Access rights to Flutter dashboard
@@ -99,13 99,13 @@ If you need access to triage images in [Flutter Gold](https://flutter-gold.skia.
 Users in the `@google.com` domain are already authorized to use Flutter Gold, but `@gmail.com` addresses can also be added to the allow list.
 
 ## Process
-The list of authorized users is maintained in the [skia build-bot repository](https://skia.googlesource.com/buildbot), in [this file](https://skia.googlesource.com/buildbot/ /refs/heads/master/golden/k8s-instances/flutter/flutter-skiacorrectness.json5). Googlers can submit a change to add to the authorized users.
 The list of authorized users is maintained in the [skia build-bot repository](https://skia.googlesource.com/buildbot), in [this file](https://skia.googlesource.com/buildbot/ /refs/heads/main/golden/k8s-instances/flutter/flutter-skiacorrectness.json5). Googlers can submit a change to add to the authorized users.
 
 This repository is also [mirrored on GitHub.](https://github.com/google/skia-buildbot)
 
 # fcontrib.org accounts
 
-If you are a team member who wants to share design docs (see [[Chat]]) but you don't want to use your own personal account, you can ask a Flutter admin for an fcontrib.org account. Ping @Hixie or another admin in the #server-support channel on Discord.
 If you are a team member who wants to share design docs (see [Chat](Chat.md)) but you don't want to use your own personal account, you can ask a Flutter admin for an fcontrib.org account. Ping @Hixie or another admin in the #server-support channel on Discord.
 
 ## Process
 

diff --git a/docs/unsorted_wiki/Data-driven-Fixes.md → docs/contributing/Data-driven-Fixes.md b/docs/unsorted_wiki/Data-driven-Fixes.md → docs/contributing/Data-driven-Fixes.md
@@ -350,7 350,7 @@ The `name` key is required unless the `index` key is provided, and isn't allowed
 
 The `nullability` key is required and indicates the type of change made to the parameter. Currently `non_null` is the only type change that is supported.
 
-The `argumentValue` key is optional and if provided will be used as the default value of the parameter. The value of the argumentValue key is a [code template](https://github.com/flutter/flutter/wiki/Data-driven-Fixes#code-template) object.
 The `argumentValue` key is optional and if provided will be used as the default value of the parameter. The value of the argumentValue key is a [code template](Data-driven-Fixes.md#code-template) object.
 
 For eg, changing the parameter `a` to non null with a default value you would write:
 

diff --git a/docs/unsorted_wiki/Design-Documents.md → docs/contributing/Design-Documents.md b/docs/unsorted_wiki/Design-Documents.md → docs/contributing/Design-Documents.md
@@ -6,7 6,7 @@ Don't forget to configure your document's Sharing settings so that everyone has
 
 The template discusses how to create a shortlink for your design doc (flutter.dev/go/...). When creating the shortlink, remember to test the URL you are publishing in an incognito window!
 
-Googlers: Design docs must be created by non-corp accounts! See [Contributor Access](https://github.com/flutter/flutter/wiki/Contributor-access#fcontriborg-accounts) for details on getting `fcontrib.org` accounts if you don't want to use your personal GMail account.
 Googlers: Design docs must be created by non-corp accounts! See [Contributor Access](Contributor-access.md#fcontriborg-accounts) for details on getting `fcontrib.org` accounts if you don't want to use your personal GMail account.
 
 When you implement a design, document it in the source code in detail. The API documentation is the usual place where we document our designs. It's perfectly reasonable for API docs to be multiple pages long with subheadings (e.g. see the docs for [RenderBox](https://master-api.flutter.dev/flutter/rendering/RenderBox-class.html)!). Do not assume that anyone will ever read your design doc after the discussion has finished. Similarly, do not assume that anyone will look at closed GitHub issues or PR discussions.
 
@@ -26,7 26,7 @@ If you wish to get feedback on your design doc, you have many options for doing
 
 * If there is an issue already filed on the topic, definitely put a link to the design doc there. People who have found the issue and want to get updates on the topic will have subscribed to the issue, so this is the most effective way to communicate with them.
 
-* File a new issue to track the design doc using [the design doc issue template](https://github.com/flutter/flutter/issues/new?labels=design doc&template=8_design_doc.yml). Assign it to yourself.
 * File a new issue to track the design doc using [the design doc issue template](https://github.com/flutter/flutter/issues/new?template=8_design_doc.yml). Assign it to yourself.
 
 * Post the link on Discord. You can post it to #hidden-chat to just get feedback from team members. You can post it to one or more of the #hackers-* channels if you want feedback from people who are interested in the general area. You can post it to the global #hackers channel if you want feedback from anyone interested in working on Flutter. If you really want feedback, you can post a request to #announcements and publish it to any server that is following ours.
 

diff --git a/docs/contributing/Setting-up-the-Framework-development-environment.md b/docs/contributing/Setting-up-the-Framework-development-environment.md
@@ -13,7 13,7 @@
  Verify that `adb` is in your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) (that `which adb` prints sensible output).
 
  If you're
- [also working on the Flutter engine](https://github.com/flutter/flutter/wiki/Setting-up-the-Engine-development-environment),
  [also working on the Flutter engine](../engine/dev/Setting-up-the-Engine-development-environment.md),
  you can use the copy of the Android platform tools in
  `.../engine/src/third_party/android_tools/sdk/platform-tools`.
 
@@ -59,6 59,6 @@ Next steps:
 
  * [Running examples](https://github.com/flutter/flutter/wiki/Running-examples), to see if your setup works.
  * [The flutter tool](https://github.com/flutter/flutter/wiki/The-flutter-tool), to learn about how the `flutter` command line tool works.
- * [Style guide for Flutter repo](https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo), to learn how to write code for Flutter.
- * [Tree hygiene](https://github.com/flutter/flutter/wiki/Tree-hygiene), to learn about how to submit patches.
- * [Signing commits](https://github.com/flutter/flutter/wiki/Signing-commits), to configure your environment to securely sign your commits.
  * [Style guide for Flutter repo](Style-guide-for-Flutter-repo.md), to learn how to write code for Flutter.
  * [Tree hygiene](Tree-hygiene.md), to learn about how to submit patches.
  * [Signing commits](Signing-commits.md), to configure your environment to securely sign your commits.
diff --git a/docs/unsorted_wiki/Signing-commits.md → docs/contributing/Signing-commits.md b/docs/unsorted_wiki/Signing-commits.md → docs/contributing/Signing-commits.md