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

Adds API reference #754

Merged
merged 11 commits into from
Jun 3, 2016
Merged

Adds API reference #754

merged 11 commits into from
Jun 3, 2016

Conversation

abeisgoat
Copy link
Contributor

Moves the Angularfire API reference into this repository

@coveralls
Copy link

Coverage Status

Coverage remained the same at 94.412% when pulling 7d8ea10 on docs-ref into 2ade0fe on master.

@googlebot
Copy link

We found a Contributor License Agreement for you (the sender of this pull request) and all commit authors, but as best as we can tell these commits were authored by someone else. If that's the case, please add them to this pull request and have them confirm that they're okay with these commits being contributed to Google. If we're mistaken and you did author these commits, just reply here to confirm.

1 similar comment
@googlebot
Copy link

We found a Contributor License Agreement for you (the sender of this pull request) and all commit authors, but as best as we can tell these commits were authored by someone else. If that's the case, please add them to this pull request and have them confirm that they're okay with these commits being contributed to Google. If we're mistaken and you did author these commits, just reply here to confirm.

@jwngr jwngr assigned abeisgoat and unassigned jwngr Jun 3, 2016
@jwngr
Copy link

jwngr commented Jun 3, 2016

Looks good to me Abe! Back to you for merging. Please use a squash commit :)

@coveralls
Copy link

Coverage Status

Coverage remained the same at 94.412% when pulling 598ea81 on docs-ref into 2ade0fe on master.

@@ -93,7 +93,7 @@ $ grunt install # install Selenium server for end-to-end tests
$ export ANGULARFIRE_TEST_DB_URL="https://<YOUR-DATABASE-NAME>.firebaseio.com"
```

3. Update the entire `config` variable in [`tests/initialize.js`](../tests/initialize.js) to
3. Update the entire `config` variable in [`tests/initialize.js`](/tests/initialize.js) to
Copy link
Contributor

Choose a reason for hiding this comment

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

This link can't be right? Should be tests/initialize.js in both places?

@katowulf
Copy link
Contributor

katowulf commented Jun 3, 2016

@AbeHaskins this almost lgtm! There are two items I'm concerned about:

  1. I think https://firebase-dot-devsite.googleplex.com is a staging URL and needs to be replaced with f.g.c.
  2. A lot of the readmes start with a leading / and I think they won't work when we commit?

@abeisgoat
Copy link
Contributor Author

Fixed staging URLs - great catch

The /s work fine though, check out this file and try the reference link :)

@coveralls
Copy link

Coverage Status

Coverage remained the same at 94.412% when pulling a1848ec on docs-ref into 2ade0fe on master.

@@ -66,7 +66,7 @@ $ bower install angularfire --save

* [Quickstart](docs/quickstart.md)
* [Guide](docs/guide/README.md)
* [API Reference](https://angularfire.firebaseapp.com/api.html)
* [API Reference](docs/reference.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

The /s work fine though, check out this file and try the reference link :)

In that case, is this one incorrect? Shouldn't it also begin with a /? Sigh, I feel like a GitHub noob suddenly. I didn't know I was so poorly versed in how URLs work.

Copy link

Choose a reason for hiding this comment

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

No, this page is at the root of the repo, so you don't need the leading /. It's just like doing require() in Node. Relative paths are relative to the current file and absolute paths are relative to the root of the repo.

@katowulf
Copy link
Contributor

katowulf commented Jun 3, 2016

One last comment, Abe! Then we're ready to merge.

@jwngr
Copy link

jwngr commented Jun 3, 2016

Looks good Abe!

@jwngr jwngr merged commit 90ce238 into master Jun 3, 2016
@jwngr jwngr deleted the docs-ref branch June 3, 2016 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants