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

Add documentation for faster iOS and macOS builds. #7467

Closed
Jonas-Sander opened this issue Dec 5, 2021 · 13 comments
Closed

Add documentation for faster iOS and macOS builds. #7467

Jonas-Sander opened this issue Dec 5, 2021 · 13 comments
Labels
good first issue Good for newcomers platform: ios Issues / PRs which are specifically for iOS. platform: macos Issues / PRs which are specifically for MacOS. resolution: fixed A fix has been merged or is pending merge from a PR. type: documentation Improvements or additions to documentation

Comments

@Jonas-Sander
Copy link

Currently you have to search through issues on GitHub to find a mention of making your flutter builds faster with https://github.com/invertase/firestore-ios-sdk-frameworks. It's hard to find and hard to know what information is up-to-date.
Additionally I think many people don't know that you can speed up iOS and macOS builds.

Even at the README at https://github.com/invertase/firestore-ios-sdk-frameworks I couldn't find any mention of macOS.

I think this should be documented at firebase.flutter.dev.

@Jonas-Sander Jonas-Sander added good first issue Good for newcomers type: documentation Improvements or additions to documentation labels Dec 5, 2021
@darshankawar darshankawar added the triage Issue is currently being triaged. label Dec 6, 2021
@darshankawar
Copy link

@Jonas-Sander
Please check this open issue discussing about xcode build times and see if it helps to answer your questions.

@darshankawar darshankawar added the blocked: customer-response Waiting for customer response, e.g. more information was requested. label Dec 6, 2021
@Jonas-Sander
Copy link
Author

I know that ticket. My point is that this information should be on firebase.flutter.dev not a ticket. Many people will never see the ticket when they use Firestore as this is never mentioned on the website.

@google-oss-bot google-oss-bot added Needs Attention This issue needs maintainer attention. and removed blocked: customer-response Waiting for customer response, e.g. more information was requested. labels Dec 6, 2021
@Salakar
Copy link
Member

Salakar commented Dec 6, 2021

It's on the homepage or am I missing something? 😅 it should just work with macos too - though I've not actually tested - are you able to confirm? If so we should update docs to say both

https://firebase.flutter.dev/docs/overview#improve-ios-build-times

@Jonas-Sander
Copy link
Author

Ah I'm really sorry, I didn't see it there - my first instinct was looking at "iOS installation" and "macOS installation".
What do you think about adding it also to "iOS installation" and "macOS installation"?

It also only mentions iOS, not macOS altough the latter can also be sped up with this workaround.

@Salakar
Copy link
Member

Salakar commented Dec 7, 2021

No worries, at the time when I built https://github.com/invertase/firestore-ios-sdk-frameworks I only tested iOS so I've not actually tested it on macOS - are you able to confirm it now does actually work on macOS too?

@Jonas-Sander
Copy link
Author

Well you said it yourself here #3185 (comment)

We've used it in the past, although I never explicitly measured the build times. Pretty sure it's working though.

@darshankawar
Copy link

maybe it would be helpful to add ios and macos sections or just tweak the current section to indicate the platforms.

@darshankawar darshankawar added platform: ios Issues / PRs which are specifically for iOS. platform: macos Issues / PRs which are specifically for MacOS. and removed Needs Attention This issue needs maintainer attention. triage Issue is currently being triaged. labels Dec 7, 2021
@Salakar
Copy link
Member

Salakar commented Dec 7, 2021

Well you said it yourself here #3185 (comment)

We've used it in the past, although I never explicitly measured the build times. Pretty sure it's working though.

Oh I did, been a while 😀

We'll get the docs updated

@Jonas-Sander
Copy link
Author

maybe it would be helpful to add ios and macos sections or just tweak the current section to indicate the platforms.

While its duplication I think the best way would be to have the full explanation in a seperate "Firestore" > "Installation"/"Build Time" topic and just have small info texts in "Getting Started" >"Overview", "iOS installation" and "macOS installation" that refer/forward to that section.

Right now I think that many people won't see it - I mean I specifically searched for it, but I didn't find it ;)

@nilsreichardt
Copy link
Contributor

There was already documentation about this:

image

https://firebase.flutter.dev/docs/firestore/overview#4-optional-improve-ios--macos-build-times

But I couldn't find this section in the new docs (https://firebase.google.com) anymore.

@nilsreichardt
Copy link
Contributor

@kevinthecheung The docs for Cloud Firestore are not public, right?

Could we add this content to the Cloud Firestore as a 4th step?

image

https://firebase.google.com/docs/firestore/quickstart

@kevinthecheung
Copy link
Collaborator

Done. Thanks, Nils!

https://firebase.google.com/docs/firestore/quickstart#dart

@nilsreichardt
Copy link
Contributor

Cool, thanks @kevinthecheung!

@darshankawar darshankawar added the resolution: fixed A fix has been merged or is pending merge from a PR. label Jul 29, 2022
@firebase firebase locked and limited conversation to collaborators Aug 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers platform: ios Issues / PRs which are specifically for iOS. platform: macos Issues / PRs which are specifically for MacOS. resolution: fixed A fix has been merged or is pending merge from a PR. type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

6 participants