New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Linux Install 3: Update the install file #9089

Closed

ghost wants to merge 5 commits into flutter:main from unknown repository

ghost commented Jul 21, 2023

Description of what this PR is changing or adding, and why:

This PR updates the "_get-sdk-linux.md" section of the Linux Installation Guide for Flutter. The revision introduces a new section on Understanding Linux Commands and reorganizes the installation instructions into two clear methods: "Install Flutter using snapd" and "Manual Installation". It also clarifies the role of flutter doctor command after installation, and provides a clear sample output for the flutter doctor command.

Issues fixed by this PR (if any):

A few mistakes and typos from my original PR. I'm still really new to PR's, especially on a big(huge) project like this, my bad :/

Presubmit checklist

This PR doesn’t contain automatically generated corrections (Grammarly or similar).
This PR follows the Google Developer Documentation Style Guidelines — for example, it doesn’t use i.e. or e.g., and it avoids I and we (first person).
This PR uses semantic line breaks of 80 characters or fewer.

Chris M added 2 commits

July 20, 2023 19:50


          Update _get-sdk-linux.md Update Linux SDK Installation Instructions

This commit enhances the Linux SDK installation instructions, clarifying the process and aligning the content with our updated style guide and glossary. It also improves the explanation of `flutter doctor`, its role, and what to expect from its output.


          Update _get-sdk-linux.md

0bd1a80

Fixed a link to the linux commands table.

ghost requested review from sfshaza2, atsansone and parlough as code owners

July 21, 2023 17:29

atsansone added the a.get-started label

atsansone self-assigned this

atsansone added review.copy devos.Linux labels

atsansone changed the title ~~Patch 3~~ Improve Linux Install 3: Update the install file

Contributor

atsansone commented Aug 23, 2023 •

edited

Loading

This may need to wait until #9238 merges. It covers related material that reworks the underlying files involved in this PR.

atsansone suggested changes

View reviewed changes

Contributor

atsansone left a comment

@wednesdei : Again, good work! Some small changes and we can merge.

src/get-started/install/_get-sdk-linux.md

                 ```terminal
                 $ flutter sdk-path
                 ```
               {{site.alert.end}}
-              ### Install Flutter manually
+              ### Method 2: Manual Installation

Contributor

atsansone Aug 26, 2023

issue: If this is Method 2, we need a Method 1. You removed the related heading in the previous section. Consider if you want to rename that heading or this one.

src/get-started/install/_get-sdk-linux.md

-              Once you have installed any missing dependencies,
-              run the `flutter doctor` command again to verify
-              that you’ve set everything up correctly.
+              After installing any missing dependencies, run the `flutter doctor` command again to verify that everything is set up correctly.

Contributor

atsansone Aug 26, 2023

chore: Use semantic breaks.

Suggested change

      
            After installing any missing dependencies, run the `flutter doctor` command again to verify that everything is set up correctly.
          
            After installing any missing dependencies,
          
            run the `flutter doctor` command again to verify your setup.

src/get-started/install/_get-sdk-linux.md

-              need to install or further tasks to perform (shown in **bold** text).
-              For example:
+              Here is an example of what you might see:

Contributor

atsansone Aug 26, 2023

suggestion: Write in active voice per GSG.

Suggested change

      
            Here is an example of what you might see:
          
            The response should resemble the following:

src/get-started/install/_get-sdk-linux.md

    
              ### Run flutter doctor

              After installing Flutter, you should run `flutter doctor` to ensure that the environment is set up correctly. This command checks your environment and displays a report in the terminal window. The Dart SDK is bundled with Flutter; it isn't necessary to install Dart separately. Review the output carefully for any additional software you may need to install or further tasks to perform.

Contributor

atsansone Aug 26, 2023

chore: Use semantic breaks.

Suggested change

      
            After installing Flutter, you should run `flutter doctor` to ensure that the environment is set up correctly. This command checks your environment and displays a report in the terminal window. The Dart SDK is bundled with Flutter; it isn't necessary to install Dart separately. Review the output carefully for any additional software you may need to install or further tasks to perform.
          
            After installing Flutter, run `flutter doctor` to verify your setup.
          
            This command checks your environment and displays a report in the terminal.
          
            Flutter bundles the Dart SDK. You don't need to install Dart as well.
          
            Review the output for any other install or configuration tasks to perform.

src/get-started/install/_get-sdk-linux.md

-              If you don't have `snapd`, or can't use it,
-              you can install Flutter using the following steps.
+              If you do not have `snapd`, or if you can't use it, follow these steps to install Flutter manually:

Contributor

atsansone Aug 26, 2023

chore: Use semantic breaks.

issue (non-blocking): Remove manually. It doesn't clarify anything, so omit it.

Suggested change

      
            If you do not have `snapd`, or if you can't use it, follow these steps to install Flutter manually:
          
            If you don't have, or can't use, `snapd`,
          
            complete the following steps to install Flutter:

src/get-started/install/_get-sdk-linux.md

-                  _current_ terminal window only.
-                  To permanently add Flutter to your path,
-                  check out [Update your path][].
+                  Note that this command sets your `PATH` variable for the current terminal window only. To add Flutter to your path permanently, refer to [Update your path][].

Contributor

atsansone Aug 26, 2023

chore:
Use semantic breaks.

Suggested change

      
                Note that this command sets your `PATH` variable for the current terminal window only. To add Flutter to your path permanently, refer to [Update your path][].
          
                This command sets your `PATH` environment variable for the current terminal session only.
          
                To add Flutter to your path for all sessions, check out [Update your path][].

atsansone added 2 commits

August 29, 2023 12:19


          Merge branch 'main' into patch-3

ee21302


          Merge branch 'main' into patch-3

96ea326

atsansone added review.await-update and removed review.copy labels


          Merge branch 'main' into patch-3

93be27d

atsansone added a commit to atsansone/website that referenced this pull request


          Added flutter#9089

87cd4b1

atsansone added a commit that referenced this pull request


          Merged #9089

d126729

atsansone mentioned this pull request

Fixes to Linux Install from @wednesdei #9442

Merged

3 tasks

Contributor

atsansone commented Sep 22, 2023

Replaced with #9442. Closing.

atsansone closed this

atsansone added a commit that referenced this pull request


          Fixes to Linux Install from @wednesdei (#9442)

7db1f7c

_Description of what this PR is changing or adding, and why:_

This replaces 
* #9082
* #9089

Fixes #8025
Fixes #2131
Fixes #6499

## Presubmit checklist

- [ ] This PR doesn’t contain automatically generated corrections
(Grammarly or similar).
- [ ] This PR follows the [Google Developer Documentation Style
Guidelines](https://developers.google.com/style) — for example, it
doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person).
- [ ] This PR uses [semantic line
breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks)
of 80 characters or fewer.

---------

Co-authored-by: Chris M <44120439+wednesdei@users.noreply.github.com>
Co-authored-by: Brett Morgan <brettmorgan@google.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>

atsansone added a commit to atsansone/website that referenced this pull request


          Fixes to Linux Install from @wednesdei (flutter#9442)

72d4623

_Description of what this PR is changing or adding, and why:_

This replaces 
* flutter#9082
* flutter#9089

Fixes flutter#8025
Fixes flutter#2131
Fixes flutter#6499

## Presubmit checklist

- [ ] This PR doesn’t contain automatically generated corrections
(Grammarly or similar).
- [ ] This PR follows the [Google Developer Documentation Style
Guidelines](https://developers.google.com/style) — for example, it
doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person).
- [ ] This PR uses [semantic line
breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks)
of 80 characters or fewer.

---------

Co-authored-by: Chris M <44120439+wednesdei@users.noreply.github.com>
Co-authored-by: Brett Morgan <brettmorgan@google.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>

atsansone added a commit to atsansone/website that referenced this pull request


          Fixes to Linux Install from @wednesdei (flutter#9442)

9c59a84

_Description of what this PR is changing or adding, and why:_

This replaces 
* flutter#9082
* flutter#9089

Fixes flutter#8025
Fixes flutter#2131
Fixes flutter#6499

## Presubmit checklist

- [ ] This PR doesn’t contain automatically generated corrections
(Grammarly or similar).
- [ ] This PR follows the [Google Developer Documentation Style
Guidelines](https://developers.google.com/style) — for example, it
doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person).
- [ ] This PR uses [semantic line
breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks)
of 80 characters or fewer.

---------

Co-authored-by: Chris M <44120439+wednesdei@users.noreply.github.com>
Co-authored-by: Brett Morgan <brettmorgan@google.com>
Co-authored-by: Parker Lougheed <parlough@gmail.com>

sfshaza2 removed the review.await-update label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

a.get-started devos.Linux