Skip to content
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.

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

Improve Linux Install 4: Update PATH install section #9087

Merged
merged 14 commits into from Aug 23, 2023
Merged

Improve Linux Install 4: Update PATH install section #9087

merged 14 commits into from Aug 23, 2023

Conversation

ghost
Copy link

@ghost ghost commented Jul 21, 2023

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

This PR updates "Update your path", of the Linux Installation Guide for Flutter. The update aims to make the instructions more explicit, ensuring they work across different shells and sessions. It also explains the necessity of updating the path and the impact on Flutter commands.

Fixes #7612
Fixes #8466

This PR addresses issues related to shell discrepancies and the persistence of Flutter commands across sessions.

Presubmit checklist

Chris M added 2 commits July 20, 2023 20:01
Revise and streamline 'Update Your Path' section. The changes ensure consistency with our table of contents, glossary, and overall document formatting. They also enhance clarity, especially for novice users, and ensure all necessary links/alerts are logically placed and maintained. The update also preserves all markdown syntax and special inclusions like '{% include docs/dart-tool.md %}'.
Added original links.
@ghost ghost requested review from sfshaza2, atsansone and parlough as code owners July 21, 2023 15:38
Copy link
Contributor

@atsansone atsansone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work! Just recommended some style issues and more concise commands.

src/get-started/install/_path-linux-chromeos.md Outdated Show resolved Hide resolved
src/get-started/install/_path-linux-chromeos.md Outdated Show resolved Hide resolved
src/get-started/install/_path-linux-chromeos.md Outdated Show resolved Hide resolved
src/get-started/install/_path-linux-chromeos.md Outdated Show resolved Hide resolved
src/get-started/install/_path-linux-chromeos.md Outdated Show resolved Hide resolved
src/get-started/install/_path-linux-chromeos.md Outdated Show resolved Hide resolved
src/get-started/install/_path-linux-chromeos.md Outdated Show resolved Hide resolved
src/get-started/install/_path-linux-chromeos.md Outdated Show resolved Hide resolved
```
{% include docs/dart-tool.md %}

### Update the path directly
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From here down, you can probably delete.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I'll get started on fixing up these changes and resubmit, :)

@atsansone atsansone changed the title Patch 4 Linux install improvements 4 Jul 21, 2023
@atsansone atsansone added the a.get-started Relates to the Getting Started section of docs.flutter.dev label Jul 24, 2023
@atsansone atsansone self-assigned this Jul 24, 2023
@atsansone atsansone added review.await-update Awaiting Updates after Edits review.copy Awaiting Copy Review devos.Linux Relates to developing apps on the Linux platform labels Jul 24, 2023
atsansone and others added 11 commits July 24, 2023 19:47
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Co-authored-by: Anthony Sansone <atsansone@users.noreply.github.com>
Updated the doc based on review feedback:

-Write in active voice per GSG.
-Use semantic breaks.
-Write as shorter sentences per GSG.
-Fixed list item numbers
-Fixed PATH to `PATH` for consistency except in headings
Copy link
Author

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GTG

@atsansone atsansone changed the title Linux install improvements 4 Improve Linux Install 4: Update PATH install section Aug 23, 2023
@atsansone
Copy link
Contributor

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

@atsansone atsansone removed review.copy Awaiting Copy Review review.await-update Awaiting Updates after Edits labels Aug 23, 2023
@atsansone atsansone added the st.RFM Ready to merge or land label Aug 23, 2023
@atsansone atsansone merged commit 1b516e9 into flutter:main Aug 23, 2023
8 of 9 checks passed
atsansone added a commit to atsansone/website that referenced this pull request Sep 19, 2023
_Description of what this PR is changing or adding, and why:_

This PR updates "Update your path", of the Linux Installation Guide for
Flutter. The update aims to make the instructions more explicit,
ensuring they work across different shells and sessions. It also
explains the necessity of updating the path and the impact on Flutter
commands.

_Issues fixed by this PR (if any):_

This PR addresses issues related to shell discrepancies and the
persistence of Flutter commands across sessions.

## Presubmit checklist
- [x] This PR doesn’t contain automatically generated corrections
(Grammarly or similar).
- [x] 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).
- [x] 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: Anthony Sansone <atsansone@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.get-started Relates to the Getting Started section of docs.flutter.dev devos.Linux Relates to developing apps on the Linux platform st.RFM Ready to merge or land
Projects
None yet
1 participant