Skip to content
This repository has been archived by the owner on May 13, 2024. It is now read-only.

Change app.js and README to better reflect actual solution code #26

Open
wants to merge 49 commits into
base: master
Choose a base branch
from

Conversation

meldaravaniel
Copy link

Working through the codeLab on https://webrtc.org/getting-started/firebase-rtc-codelab, I discovered the instructions and the app.js in the codelab were different enough from the solution as to be difficult to follow. I took the solution's code, copied it into the lab code and removed sections accordingly. Also modified the solution's code to include a function the instructions talked about (see forthcoming pull request to the solution branch).

Finally, I copied all the instructions into the README and corrected them to reflect what the solutions code actually contains, some differences in Firestore, and added tips on how to do this if you're using git-bash.

I would correct the actual instructions on the website, but I don't think I have access. So adding it to the README seemed a close second, though annoying that they'll be out of sync for a bit.

This version did not match the solution correctly and made it confusing to do the tutorial without just looking at the solution code.  I copied the (also changed) solution app.js into this and removed the code sections that are to be added by the tutorial.
I don't know how to update the actual instructions website, so barring that...I enhanced the readme to include them.
@meldaravaniel
Copy link
Author

meldaravaniel commented Dec 18, 2020

@guidou I'm going to pick on you, since it looks like you've been working on the Samples project for WebRTC and it won't let me @ anyone else 😅 Do you know who should be contacted for PR approval for this codelab? It looks like there are a few pending PRs hanging out, but I would recommend not merging #24 as I've corrected app.js to basically include that, but also make it match the actual solution code. #25 is just a typo fix, so that merge is probably fine.

I would also love to update the actual text of the instructions on the codelab, but I didn't see a contribution link for that one, so I settled for the README.

I'd also like to test this, but I didn't have the time at the moment, apologies.

It does seem like there's a steady drip of folks trying to use the codelab and they're all getting frustrated with it. This would really help.

Edited to add: oh derp. Found the repo for the website...whelp. Off to go make more PRs. :D

Edit 2: nvm that's the old site, deprecated.

@google-cla
Copy link

google-cla bot commented Dec 19, 2020

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@google-cla
Copy link

google-cla bot commented Dec 19, 2020

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@google-cla
Copy link

google-cla bot commented Dec 19, 2020

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@google-cla
Copy link

google-cla bot commented Dec 19, 2020

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

@meldaravaniel
Copy link
Author

@natkuhn now that you're in on this 😈 *evil laugh* 😈 the PR needs a CLA signature from you before it can be merged (if that ever happens ;P ). It's a standard requirement for contributions merged into Google-related repos. See above instructions from the cla bot.

@natkuhn
Copy link

natkuhn commented Dec 19, 2020

@meldaravaniel all done but I am guessing you should be the one to comment @googlebot I fixed it.? [Edit: I just went ahead and did it.] The other change I thought of, but forgot to mention, is to make the command lines without sh be the default. Wasn't sure why it said git-bash rather than just bash, etc. Not sure who would need the sh.

@natkuhn
Copy link

natkuhn commented Dec 19, 2020

@googlebot I fixed it.

@google-cla
Copy link

google-cla bot commented Dec 19, 2020

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

1 similar comment
@google-cla
Copy link

google-cla bot commented Dec 19, 2020

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

@natkuhn
Copy link

natkuhn commented Dec 19, 2020

@googlebot I consent.

@google-cla
Copy link

google-cla bot commented Dec 19, 2020

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

@meldaravaniel
Copy link
Author

...make the command lines without sh be the default. Wasn't sure why it said git-bash rather than just bash, etc. Not sure who would need the sh.

@natkuhn yeah that's reasonable. I use gitbash, so I wrote that for myself, but you're probably right it's not necessary to specify that fine-grained.

meldaravaniel and others added 4 commits December 19, 2020 15:11
* fix template string for log message
* add indentation level in session description listener code
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants