958909 - Add popcorn methods to the docs, some typo fixes and correctness

Status: VERIFIED FIXED

(Webmaker Graveyard :: popcorn.js, defect)

Description

[Scott [:thecount] Downe]

Mainly adding a setction of docs for adding, removing, getting and updating track events.

Not sure how we missed these, but couldn't find them anywhere in the docs and they probably should be.

I also did some correctness and added info on the update functionality. Some grammar fixes too.

Comment 1

[Scott [:thecount] Downe]

Attachment: https://github.com/mozilla/popcorn-docs/pull/37

Comment 2

[Matthew Schranz [:mjschranz]]

Comment on attachment 8358890 [details] [review]
https://github.com/mozilla/popcorn-docs/pull/37

Comments.

Comment 3

[Jon Buckley [:jbuck]]

Comment on attachment 8358890 [details] [review]
https://github.com/mozilla/popcorn-docs/pull/37

The structure looks good to me. Be sure to fix up the things Matt has noted though!

When you want to push these docs live, you can run the `sync.sh` script. If you don't have ssh access to that box, I can get that setup for you.

Comment 4

[Scott [:thecount] Downe]

Yeah, I need credentials now.

Also, if possible do we have credentials to popcornjs.org and the cdn? We'll need to update what's on the site to match what the new docs say. I am OK with a new cdn, but I think we should update popcornjs.org, and I want to be the one to be able to do it.

Comment 5

[Jon Buckley [:jbuck]]

Alright, created credentials for scott to push docs up.

Comment 6

[Scott [:thecount] Downe]

Staged: https://github.com/mozilla/popcorn-docs/commit/d3941389e1673faa1e298a7dfac81118074fb1c4

Needs varification.