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

Change installation to use bundles #912

Merged
merged 17 commits into from Apr 5, 2018
Merged

Change installation to use bundles #912

merged 17 commits into from Apr 5, 2018

Conversation

mit-mit
Copy link
Member

@mit-mit mit-mit commented Mar 27, 2018

@gspencergoog @DanTup, please review!

@DanTup can you help with needed js to make the bundle links in get-sdk.md and get-sdk-win.md dynamic to latest beta bundle?

@googlebot googlebot added the cla: yes Contributor has signed the Contributor License Agreement label Mar 27, 2018
@mit-mit mit-mit mentioned this pull request Mar 27, 2018
@mit-mit
Copy link
Member Author

mit-mit commented Mar 27, 2018

@DanTup one other thing I noticed, on Windows can you not pin .cmd files to the taskbar?

@mit-mit
Copy link
Member Author

mit-mit commented Mar 27, 2018

Staged here: https://staging-mit.firebaseapp.com

@gspencergoog
Copy link
Contributor

I noticed that on this page: https://staging-mit.firebaseapp.com/setup-windows/#get-the-flutter-sdk that the link to the beta has the old version number (old since today, since we just released another beta). You might want to (eventually) have some code that automatically links the latest beta on that page.

@mit-mit
Copy link
Member Author

mit-mit commented Mar 27, 2018

Yup, that:s the js part I mentioned that Danny is going to help with so it's dynamic.

@DanTup
Copy link
Contributor

DanTup commented Mar 28, 2018

@mit-mit @gspencergoog The current Windows releases in that file are .tar.xz? I don't think Windows users will know what to do with them? (not everyone has a third party zip tool; I don't!)

    {
      "hash": "5a58b36e36b8d7aace89d3950e6deb307956a6a0",
      "channel": "beta",
      "version": "v0.2.3",
      "release_date": "2018-03-27T17:46:01.049354Z",
      "archive": "beta/windows/flutter_windows_v0.2.3-beta.tar.xz"
    },

@DanTup
Copy link
Contributor

DanTup commented Mar 28, 2018

Oh, I think it's just a bug in the JSON generation, as the actual filename in storage is a zip.

Same goes for macOS one.

@googlebot
Copy link

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

@googlebot googlebot added cla: no Contributor has not signed the Contributor License Agreement and removed cla: yes Contributor has signed the Contributor License Agreement labels Mar 28, 2018
@DanTup
Copy link
Contributor

DanTup commented Mar 28, 2018

Ok, I've pushed changes to update the links.. Few things to note:

  1. The channel "beta" is hard-coded in the JS and will need changing to release one day in the future. I did consider putting it on the links (eg. {: .download-latest-link-macos data-channel="beta" }) however then it'd be in three places instead of 1.
  2. The json files need fixing before this gets published, else the links will be 404s for Mac/Windows
  3. I've added a condition around the macOS download link tit displays the Linux one for the Linux page (they share an include)
  4. If an error occurs, the links will be left as they are in the source. Currently this is v0.1.5. Not sure if we want to tweak this (hopefully it won't error for people, but networks can be flaky!).

@DanTup
Copy link
Contributor

DanTup commented Mar 28, 2018

@mit-mit I guess that CLA warning is for me? I committed with my Google address - do I need to complete a CLA for it? Signed for future, and of course I'm happy for my commits to be contributed to this project.

@DanTup
Copy link
Contributor

DanTup commented Mar 28, 2018

on Windows can you not pin .cmd files to the taskbar?

According to the internet, apparently not. There are some workarounds though.

I think it's best to ultimately guide people to getting their normal terminal set up correctly though (if they're PoSh users they won't want to keep two consoles open, one for flutter commands and one for other stuff). If they configure PATH correctly this should just work, and has the advantages of Dart Code using it to find the SDK and also Code's embedded terminal working for flutter commands.

@mit-mit
Copy link
Member Author

mit-mit commented Mar 28, 2018

@DanTup thanks for adding the scripting for the download link!

One complication: The file name of the downloaded bundle is also present a few lines further down (on the mac and linux ones) as part of the extract step. Any idea for how to handle that?

@mit-mit
Copy link
Member Author

mit-mit commented Mar 28, 2018

I think it's best to ultimately guide people to getting their normal terminal set up correctly

OK, let me add back the path steps as optional. I think it makes sense that they can start easily in the Flutter Console, and then add path as needed.

@mit-mit
Copy link
Member Author

mit-mit commented Mar 28, 2018

@DanTup, re this:

If an error occurs, the links will be left as they are in the source.

I think we are better off having just something like [calculating] there by default?

@DanTup
Copy link
Contributor

DanTup commented Mar 28, 2018

@mit-mit Maybe [loading] would sound better? What do we do if it fails?

Also show (failed) if the network fails and a placeholder zip filename.
@DanTup
Copy link
Contributor

DanTup commented Mar 28, 2018

Ok, I've put (loading...) as a placeholder and changed it to (failed) if we fail. I've also wrapped a span around the filenames in the command line so we can swap them out (it has a placeholder with _xxx until we get the data and remains that way if it fails).

Feel free to tweak as required or shout if you want me to do anything.

@mit-mit
Copy link
Member Author

mit-mit commented Mar 28, 2018

sgtm, over to @gspencergoog for review

@gspencergoog
Copy link
Contributor

Sorry about the metadata having .tar.xz suffixes: I've fixed that. That wasn't a bug, it was human error: the code to write the new format for the metadata files is in the master branch, but not in dev or beta yet, so I have to update the metadata files by hand until it is.

@DanTup
Copy link
Contributor

DanTup commented Mar 28, 2018

Aha, great :)

@mit-mit Is your stage supposed to be updated with these changes? Still seems to show the old version here, not sure if it's broken or just stale.

@gspencergoog
Copy link
Contributor

For the linux setup it has:
unzip ~/Downloads/flutter_linux_v0.2.3-beta.tar.xz

it should be:
tar xf ~/Downloads/flutter_linux_v0.2.3-beta.tar.xz

{% commandline %}
cd ~/development
{% if page.url contains "linux" %}
unzip ~/Downloads/<span class="download-latest-link-filename-linux">flutter_linux_xxx.tar.xz</span>
Copy link
Contributor

Choose a reason for hiding this comment

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

unzip --> tar xf

{% else %}
* [(loading...)](#){:.download-latest-link-macos}
{% endif %}<br><br>
1. Extract the file in the desired location, e.g.:
Copy link
Contributor

Choose a reason for hiding this comment

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

For macOS, you might say something like "Either double click to extract the archive, or extract the file in the desired location from the command line:"

In reality, you could probably double-click on the archive in Linux too, since most distros have a built-in extractor, but I'm not sure how universal that is (probably pretty universal).

@mit-mit
Copy link
Member Author

mit-mit commented Mar 28, 2018

Fixed and re-deployed!

@DanTup
Copy link
Contributor

DanTup commented Mar 29, 2018

Stage site lgtm!

@gspencergoog
Copy link
Contributor

32384589-a60f0e74-c078-11e7-9bc1-e5b5287aea9d

@mit-mit
Copy link
Member Author

mit-mit commented Mar 30, 2018

Great, let's land this when I'm back Tuesday next week?

@Hixie
Copy link
Contributor

Hixie commented Apr 5, 2018

LGTM

@mit-mit mit-mit merged commit 3f57ad2 into flutter:master Apr 5, 2018
@mit-mit mit-mit deleted the install-with-bundles branch April 5, 2018 17:38
ZhangQinglian added a commit to flutter-dev/website that referenced this pull request Apr 12, 2018
* Fix typo in index.md. (flutter#860)

* Update flutter-for-react-native.md (flutter#859)

* Fix typo (flutter#861)

* Update flutter-for-react-native.md (flutter#865)

This sentence read: 'In order to make Row' and then proceeded to show how to arrange things in a column.

* Fix some more typos (flutter#862)

* Update MaterialApp ctor argument mentioned in debugging.md (flutter#863)

Previously `debugging.md` mentioned `debugShowGrid` as an argument for `MaterialApp`'s constructor.
I believe this came from the `stocks` example as `MaterialApp` has `debugShowMateralGrid` not `debugShowGrid`.

* Clarify which devices we do not support (flutter#856)

Fixes flutter/flutter#14437

* Update docs.md

* Use the more stable beta channel for analysis (flutter#872)

This works around flutter/flutter#15293 and flutter/flutter#15301.

* Fix a typo in the class description (flutter#876)

* Cookbook part4 (flutter#869)

* More Recipes for the cookbook on Images, Lists, and Gesture Handling.

* Fix Horizontal List complete example

* Fix Typo in Long Lists recipe

* Next few recipes

* Fix indent (flutter#864)

* Allow linking directly to specific tool and persist across site (flutter#831)

* Allow selection of tab from hash in url

* Add selected tool to url during tab changes

* Persist selected tool in localStorage to follow around site

* Use replaceState to avoid causing history entries if you flip back and forth.

Fixes flutter/flutter#14888.

* Fixes the explin (flutter#875)

* Add hyphens to links in post content (flutter#873)

This avoids extending width of post content if links have long words.

* Update using-packages.md (flutter#867)

* Update using-packages.md

Adding word "Or" to clarify running packages get command can be done from IntelliJ or from Terminal

* Add a forced newline

* Align bridging sidebar titles, and shorten to fit on one line (flutter#855)

* Align bridging sidebar titles, and shorten to fit on one line

* Align Web devs page title with Android and React native ones

* using typo (flutter#879)

* Fix typo (flutter#881)

* Fixed spelling error in getting-started (flutter#878)

* Delete a box design of sentence (flutter#882)

A sentence of "... at the following link ..." of "Problems?" of Step 6, it is only surrounded a box design (by div, pre, and code tags). Other steps, it is a normal design sentence.

* Fixes the clipping issue on Safari for Flutter for RN section. (flutter#886)

* Adds a Flutter for RN md file and a sidebar link

* Image link and style fixes

* Flutter get-started link updated

* Hello world text and preview fixes along with other minor fixes

* Hello world code and preview fixes along with other minor fixes

* Deletes junk flutter for rn files

* Update flutter-for-react-native.md

* Fixes the clipping issue on mobile browsers

* Add cookbook image demos, fix dismissable link (flutter#880)

* Add cookbook image demos, fix dismissable link

* Change Dismissable to Dismissible

* Jank no more doc (flutter#870)

* Stashing

* Stashed.

* A new version of the jank page. (In process)

* New screenshots, and less text about Observatory.

* Incorporating Chinmay's feedback.

* Tweaking

* Tweaking, changing title.

* Incorporating feedback.

* Tweaking

* Tool UI (pics) changed, and incorporating feedback.

* Fixing alt text on images.

* Incorporating Devon's feedback.

* Adding a link to the new performance profiling page.

* Incorporating Wm's feedback.

* Adding more feedback, and placing the doc in the sidenav.

* tweak to the new performance article (flutter#888)

* Remove space breaking a markdown link. (flutter#887)

The extra space character prevents the link from being clickable.

* typo fixes (flutter#890)

* Add a few more recipes and two migrations (flutter#884)

* [Cookbook] Reading, writing data to key-value (shared preferences) (flutter#877)

* Adde key-value section to flutter cookbook

* Fixed spelling errors, grammar. Added better example

* Fixed grammar, changed you and your to we and our

* Fixed text and grammar.

* Added 'the' to few places.

* Update main.dart (flutter#885)

Update to coincide with Update index.md flutter#883 - Added the textDirection property to reflect the API change for text RTL support for text widgets that are not a descendant of MaterialApp.

* Update index.md (flutter#883)

Added the textDirection property to reflect the API change for text RTL support for text widgets that are not a descendant of MaterialApp.

* remove references to deprecated createHttpClient method (flutter#893)

* Fix constructor name of `MyStatefulWidget` (flutter#898)

* Add missing parameter (flutter#891)

* Clarify why Android Studio is needed (flutter#900)

* update (flutter#892)

* Add new SDK archive page (flutter#901)

* Add new SDK archive page

* Fix typos

* Update tabs to support different types/names

This restricts the tab changing to a container but also makes the prefix/storage name dynamic so we don't have to call non-editor tabs editors (eg. OSes).

* Add a table of releases to sdk-archive page

* Show a failure message when loading fails

* Move Master inside tabs

* Fix page jumping to top when showing all

* Change "Mac OS" to "macOS"

The rest of the site is already using macOS.

* Don't request archives when we're not rendering them

* Remove conversion/sort code

No longer required since source data format matches what we converted to.

* A few minor typos (flutter#894)

* Add cupertino picker to widget catalog (flutter#903)

* Replace heart with tile in getting-started (flutter#904)

* Add new recipes for fonts, animations, and drawers (flutter#896)

* Fix Build (flutter#916)

* Make Windows requirments more specific (flutter#917)

* Added example to show RESTful JSON POST (flutter#839)

* De dupe ide steps (flutter#899)

* Remove redundant IDE steps

* Remove unused file

* Remove one more mentioning of IDE steps

* Fix typo (flutter#919)

* Update index.md (flutter#914)

Delete </aside> closing tag that was left.

* Update index.md (flutter#910)

Fix duplicate "the the".

* Fix website build (flutter#922)

* Fix links in "File issue" links

page.path is the filename from the repo, page.url is the url of the resulting page.

Fixes flutter/flutter#15349.

* Update index.md (flutter#924)

* Update index.md

* Update index.md

* Update iOS setup (flutter#918)

Reflect Xcode 9.0 requirement given by flutter doctor

* Fix networking example (flutter#921)

* Update fetch-data.md

Rename `json` variable to `_json`

* Rename _json to responseJson

* Add VS Code to Using-IDE page (flutter#906)

* Add tabs and empty VS Code page

This is on its own page so it can have a toc (our current kramdown tov plugin appears to not support multiple within one page).

* Fix bad IDs for tabs

* Support href-based tabs

If a tab has a data-tab-href then navigate to it. If no tab is found, bail out and don't hide content (this allows us to skip all the storage/hash fragments for href-based tabs).

* Commit all Android Studio content in VS Code page

To make it easier to review the changes made, if required.

* First cut at VS Code IDE page

* Remove ID that link checker doesn't like

This does work, but the checker can't verify it :(

* Tweaks based on @devoncarew's feedback

* Tweaks from review

plus fix for rebasing over latest tab changes that require a container around them.

* site bar -> Side Bar

* Add link to #vscode

Also change exclusion in rakefile to be a regex, seems like "#" was being compared as an exact string.

* Link "command palette" to VS Code docs

* Add docs on sharing assets with the platform

* Remove developer.apple.com links from link checking (flutter#928)

* Remove developer.apple.com links from link checking

To work around flutter/flutter#16268

* Commas for the win

* Change installation to use bundles (flutter#912)

Change Flutter installation to use pre-built installation packages that can simply be extracted for installation.

* Revert previous update of asset section.

* Fix Apple.com links (flutter#931)

* Add docs on sharing assets with the platform (flutter#929)

* Improve the Views section of flutter-for-android (flutter#927)

* Improve the Intents section of flutter-for-android (flutter#932)

* Improve the Views section of flutter-for-android

* Improve Intents section in flutter-for-android

* Improve the Async UI section in flutter-for-android (flutter#933)

* Improve the Project structure and Resources section in flutter-for-android (flutter#934)

* Improve the Async UI section in flutter-for-android

* Improve the Project section in flutter-for-android

* Update version of http in sample code

* adding rake to Gemfile. Rake is used to validate links as described in README's developing step 7 (flutter#930)

* Fix typo (flutter#936)

Fix minor typos in catalog/samples page

* Updating the accessibility info. (flutter#926)

* Facebook Login Package (flutter#895)

Since the https://pub.dartlang.org/packages/flutter_facebook_connect is no longer maintained, updated it with https://pub.dartlang.org/packages/flutter_facebook_login

* Update Learn More link to point to beta 2 post (flutter#943)

* Fix code validation issue (flutter#944)

Currently failing with `child' is deprecated and shouldn't be used at example/text_input_md_1.dart:31:15 • deprecated_member_use`

* Make the formatter happy (flutter#945)

Follow-up to flutter#944

* Cookbook: Background processing, Orientation, and Updates (flutter#920)

* Update key-value recipe

* Add background processing example

* Add orientation recipe

* Update a few stale FAQ entries (flutter#940)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: no Contributor has not signed the Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants