[Tracker] Documentation changes

[IzaakGough]

Opening this issue to track issues which are resolved by documentation changes in a single place.

#1019

This is addressed in #1913

#1502

• Needed doc change: document the caveat that setGlobalOptions() must run before function definitions are evaluated, and that with multi-file JS/ESM layouts, import order / module evaluation can prevent global options from applying as users expect.
• Why: the current 2nd gen reference still states that setGlobalOptions() “sets default options for all functions written using the 2nd gen SDK,” but the docs do not mention the multi-file / ESM import-order caveat or recommend a safe pattern. The organize/manage pages also do not describe this.
• Docs checked: 2nd gen API reference, Manage functions, Organize multiple functions

#1616

The documentation regarding the process of upgrading from v1 to v2 has been updated here to make things clearer.

[egilmorez]

Thanks Isaac!

Everything in 1019 needs to be addressed in code comments in the source before we regen the doc output. Can you do that, or should I work with an internal SWE?

For 1616, we depend on users to be focused in the correct set, 1st or 2nd gen. However, I recently modified the upgrade guide to drive that in with a bigger hammer. See the note at this section's end: https://firebase.google.com/docs/functions/2nd-gen-upgrade#update-imports

Let me look into the other two issues with our CF3 DRE and get back to this issue. Thanks again!

[IzaakGough]

Hi @egilmorez , thanks for the response!

For 1019, I have opened #1913 to address this.

For 1616, the changes to the upgrade guide look great. This should be much clearer for users.

Thanks again for your help with these!