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

Update firebase documentation #17759

Merged
merged 3 commits into from
Aug 29, 2018

Conversation

cathyxz
Copy link
Contributor

@cathyxz cathyxz commented Aug 28, 2018

Add a line for --min as well as explicit instructions for setting the firebase public folder to firebase and provide a sample firebase.json.

@cathyxz
Copy link
Contributor Author

cathyxz commented Aug 28, 2018

@gmajoulet thanks for checking it out and giving feedback! Let me know if there's anything else that's confusing or would be helpful to add. =)

@cathyxz cathyxz requested a review from sparhami August 29, 2018 18:19
Copy link
Contributor

@gmajoulet gmajoulet left a comment

Choose a reason for hiding this comment

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

Thanks for improving this! This is so useful

@@ -305,7 +305,7 @@ gulp firebase
firebase deploy
```

`gulp firebase` will generate a `firebase` folder and copy over all files from `dist`, `examples` and `test/manual`. It will rewrite all urls in the copied files to point to the local versions of AMP (i.e. the ones copied from `dist` to `firebase/dist`). It assumes that you have already run `gulp build` or `gulp dist` prior to running `gulp firebase`. When you initialize firebase, you should set the `firebase` `public` directory to `firebase`. This way `firebase deploy` will just directly copy and deploy the contents of the generated `firebase` folder. As an example, your `firebase.json` file can look something like this:
`gulp firebase` will generate a `firebase` folder and copy over all files from `dist`, `examples` and `test/manual`. It will rewrite all urls in the copied files to point to the local versions of AMP (i.e. the ones copied from `dist` to `firebase/dist`). It assumes that you have already run `gulp build` or `gulp dist` prior to running `gulp firebase` (use `gulp build` with `gulp firebase` and `gulp dist` with `gulp firebase --min`. When you initialize firebase, you should set the `firebase` `public` directory to `firebase`. This way `firebase deploy` will just directly copy and deploy the contents of the generated `firebase` folder. As an example, your `firebase.json` file can look something like this:
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: closing ) after "use gulp build with gulp firebase and gulp dist with gulp firebase --min"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice catch. Thanks!

@cathyxz cathyxz merged commit 39b20d7 into ampproject:master Aug 29, 2018
@cathyxz cathyxz deleted the feature/firebase-documentation branch August 29, 2018 19:38
Enriqe pushed a commit to Enriqe/amphtml that referenced this pull request Nov 28, 2018
* Update firebase documentation

* Add a line about dist and build per feedback

* Add closing parentheses
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants