Skip to content

Commit 80d44f6

Browse files
authored
Move install help page to new /install directory (#11954)
- Moves `/get-started/install/help` to `/install/troubleshoot` - Cleans up the page formatting and link references - Updates the help icon include for improved accessibility Contributes to #11911 **Staged:** https://flutter-docs-prod--pr11954-misc-install-troubleshootin-5xquyl0u.web.app/install/troubleshoot
1 parent dfa20a4 commit 80d44f6

File tree

3 files changed

+44
-38
lines changed

3 files changed

+44
-38
lines changed

firebase.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@
125125
{ "source": "/get-started/flutter-for/ios-devs", "destination": "/get-started/flutter-for/swiftui-devs", "type": 301 },
126126
{ "source": "/get-started/fwe/:rest*", "destination": "/get-started/fundamentals/:rest*", "type": 301 },
127127
{ "source": "/get-started/install/null", "destination": "/get-started/install", "type": 301 },
128+
{ "source": "/get-started/install/help", "destination": "/install/troubleshoot", "type": 301 },
128129
{ "source": "/get-started/learn-more", "destination": "/get-started/learn-flutter", "type": 301 },
129130
{ "source": "/get-started/test-drive*", "destination": "/get-started/codelab", "type": 301 },
130131
{ "source": "/get-started/uninstall", "destination": "/install/uninstall", "type": 301 },

src/_includes/docs/help-link.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p class="install-help">
2-
<a id='{{ location }}' href='/get-started/install/help{{ section }}'>
3-
<span class='material-symbols'>help</span>
2+
<a id="{{ location }}" href="/install/troubleshoot{{ section }}" target="_blank" title="Troubleshoot common installation issues" aria-label="Troubleshoot common installation issues">
3+
<span class="material-symbols" aria-hidden="true">help</span>
44
<span>Help</span>
5-
</a>
5+
</a>
66
</p>

src/content/get-started/install/help.md renamed to src/content/install/troubleshoot.md

Lines changed: 40 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,35 @@
11
---
2-
title: Install help
3-
description: This page describes some common installation issues new Flutter users have run into and offers suggestions to resolve them.
2+
title: Install troubleshooting
3+
short-title: Troubleshoot
4+
description: >-
5+
Get help with common installation issues new Flutter developers have run into.
46
---
57

6-
This page describes some common installation issues new Flutter users have
8+
This page describes some common installation issues new Flutter users have
79
encountered and offers suggestions on how to resolve them.
810
If you are still experiencing problems, consider reaching out to any of
911
the resources listed under [community support channels][].
1012
To add a topic to this page or make a correction,
1113
you can file an issue or a pull request using the buttons at the top of the page.
1214

13-
## Get the Flutter SDK
15+
[community support channels]: #community-support
1416

17+
## Get the Flutter SDK
1518

1619
### Unable to find the `flutter` command
1720

1821
__What does this issue look like?__
1922

20-
When you try to run the `flutter` command,
21-
the console fails to find it.
23+
When you try to run the `flutter` command,
24+
the console fails to find it.
2225
The error usually looks as follows:
2326

2427
```plaintext
2528
'flutter' is not recognized as an internal or external command operable program or batch file
2629
```
2730

28-
Error messages on macOS and Linux could look slightly different from
29-
the one on Windows.
31+
Error messages on macOS and Linux could look slightly different from
32+
the one on Windows.
3033

3134
__Explanation and suggestions__
3235

@@ -40,6 +43,9 @@ to identify the location of your `flutter` folder.
4043

4144
See also: [Configuring PATH and Environment Variables - Dart Code][config path]
4245

46+
[windows path]: https://www.wikihow.com/Change-the-PATH-Environment-Variable-on-Windows
47+
[set up VS Code]: /get-started/editor
48+
[config path]: https://dartcode.org/docs/configuring-path-and-environment-variables/
4349

4450
### Flutter in special folders
4551

@@ -65,27 +71,27 @@ such as `C:\src\flutter`.
6571

6672
### Having multiple versions of Java installed
6773

68-
__What does this issue look like?__
74+
__What does this issue look like?__
6975

7076
The command `flutter doctor --android-licenses` fails.
7177
Running `flutter doctor –verbose` gives an error message
7278
like the following:
7379

7480
```plaintext
75-
java.lang.UnsupportedClassVersionError: com/android/prefs/AndroidLocationsProvider
76-
has been compiled by a more recent version of the Java Runtime (class file version 55.0),
81+
java.lang.UnsupportedClassVersionError: com/android/prefs/AndroidLocationsProvider
82+
has been compiled by a more recent version of the Java Runtime (class file version 55.0),
7783
this version of the Java Runtime only recognizes class file versions up to 52.0
7884
```
7985

8086
__Explanation and suggestions__
8187

8288
The error occurs when an older version of the
8389
Java Development Kit (JDK)
84-
is installed on your computer.
90+
is installed on your computer.
8591

8692
If you don't need multiple versions of Java,
8793
uninstall existing JDKs from your computer.
88-
Flutter automatically uses the JDK included in Android Studio.
94+
Flutter automatically uses the JDK included in Android Studio.
8995

9096
If you do need another version of Java,
9197
try the workaround described in
@@ -96,6 +102,10 @@ check out the [Android Java Gradle migration guide][]
96102
or [flutter doctor --android-licenses not working due to
97103
java.lang.UnsupportedClassVersionError - Stack Overflow][so java version].
98104

105+
[java binary path]: {{site.repo.flutter}}/issues/106416#issuecomment-1522198064
106+
[Android Java Gradle migration guide]: /release/breaking-changes/android-java-gradle-migration-guide
107+
[so java version]: {{site.so}}/questions/75328050/
108+
99109
### `cmdline-tools` component is missing
100110

101111
__What does this issue look like?__
@@ -105,9 +115,9 @@ The `flutter doctor` command complains that the
105115
For example:
106116

107117
```plaintext noHighlight
108-
[!] Android toolchain - develop for Android devices (Android SDK version 33.0.2)
109-
• Android SDK at C:\Users\My PC\AppData\Local\Android\sdk
110-
X cmdline-tools component is missing
118+
[!] Android toolchain - develop for Android devices (Android SDK version 33.0.2)
119+
• Android SDK at C:\Users\My PC\AppData\Local\Android\sdk
120+
X cmdline-tools component is missing
111121
```
112122

113123
__Explanation and suggestions__
@@ -116,20 +126,21 @@ The easiest way to get the cmdline-tools is through the
116126
SDK Manager in Android Studio.
117127
To do this, use the following instructions:
118128

119-
1. Open the SDK Manager from Android Studio,
120-
by selecting **Tools > SDK Manager** from the menu bar.
129+
1. Open the SDK Manager from Android Studio by
130+
selecting **Tools > SDK Manager** from the menu bar.
121131
2. Select the latest Android SDK
122132
(or a specific version that your app requires),
123-
Android SDK Command-line Tools, and Android SDK Build-Tools.
133+
Android SDK Command-line Tools, and Android SDK Build-Tools.
124134
3. Click **Apply** to install the selected artifacts.
125135

126-
![Android Studio SDK
127-
Manager](/assets/images/docs/get-started/install_android_tools.png)
136+
![Android Studio SDK Manager](/assets/images/docs/get-started/install_android_tools.png)
128137

129138
If you're not using Android Studio,
130139
you can download the tools using the
131140
[sdkmanager][] command-line tool.
132141

142+
[sdkmanager]: {{site.android-dev}}/studio/command-line/sdkmanager
143+
133144
## macOS setup
134145

135146
### SocketException: Send failed, OS Error: No route to host, errno = 65
@@ -187,11 +198,11 @@ exit code: 69
187198

188199
__Explanation and suggestions__
189200

190-
This issue is related to networking.
191-
Try the following instructions to troubleshoot:
201+
This issue is related to networking.
202+
Try the following instructions to troubleshoot:
192203

193204
* Check your internet connection.
194-
Make sure that you are connected to the
205+
Make sure that you're connected to the
195206
internet and that your connection is stable.
196207
* Restart your devices, including your computer
197208
and networking equipment.
@@ -202,6 +213,8 @@ Try the following instructions to troubleshoot:
202213
with the `flutter doctor -v` command and ask for help in
203214
one of the [community support channels][].
204215

216+
[community support channels]: #community-support
217+
205218
## Community support
206219

207220
The Flutter community is helpful and welcoming.
@@ -210,21 +223,13 @@ consider asking for support from one of the following channels:
210223

211224
* [/r/flutterhelp](https://www.reddit.com/r/flutterhelp/) on Reddit
212225
* [/r/flutterdev](https://discord.gg/rflutterdev) on Discord,
213-
particularly the `install-and-setup` channel on this server.
214-
* [StackOverflow][],
226+
particularly the `install-and-setup` channel on this server.
227+
* [StackOverflow][],
215228
in particular, questions tagged with [#flutter][] or [#dart][].
216229

217230
To be respectful of everyone's time,
218-
search the archive for a similar issue before posting a new one.
231+
search the archive for a similar issue before posting a new one.
219232

220233
[StackOverflow]: {{site.so}}
221234
[#dart]: {{site.so}}/questions/tagged/dart
222235
[#flutter]: {{site.so}}/questions/tagged/flutter
223-
[Android Java Gradle migration guide]: /release/breaking-changes/android-java-gradle-migration-guide
224-
[community support channels]: #community-support
225-
[java binary path]: {{site.repo.flutter}}/issues/106416#issuecomment-1522198064
226-
[so java version]: {{site.so}}/questions/75328050/
227-
[set up VS Code]: /get-started/editor
228-
[config path]: https://dartcode.org/docs/configuring-path-and-environment-variables/
229-
[sdkmanager]: {{site.android-dev}}/studio/command-line/sdkmanager
230-
[windows path]: https://www.wikihow.com/Change-the-PATH-Environment-Variable-on-Windows

0 commit comments

Comments
 (0)