angular / angular/angularfire

Docs: Emulator guide missing breaking changes in >7.0

Open
#3,205 3 comments 7 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
7.8k
Forks
2.2k
Avg merge
22h 28m
Merged PRs (30d)
6

Description

### How to reproduce these conditions

The [upgrade guide](https://github.com/angular/angularfire/blob/master/docs/version-7-upgrade.md) for v7 mentions a breaking change: "`USE_EMULATOR` DI token is now in the form of `['http://localhost:9099']`". This change is not documented in [the Emulators guide](https://github.com/angular/angularfire/blob/master/docs/emulators/emulators.md). The Emulators guide still shows:
`{ provide: USE_AUTH_EMULATOR, useValue: environment.useEmulators ? ['localhost', 9099] : undefined },`

This is shown under '6.1 Method'. Something should probably be written for v7+.

Contributor guide

Open the contributing guide

Research direction

Read docs/version-7-upgrade.md and compare its USE_EMULATOR guidance with the example in docs/emulators/emulators.md under “6.1 Method.” Update the Emulators guide for v7+ so the documented USE_AUTH_EMULATOR value matches the breaking-change format, then verify the example and surrounding explanation are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, firebase, typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
57/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.