939845 - Bring login documentation up-to-date

Status: RESOLVED INCOMPLETE

(Webmaker Graveyard :: Login, defect)

Description

[Kieran Sedgwick (:sedge)]

This is a follow-up to bug 939842, with regards to the login server.  Documentation needs to be clear and tested.

Comment 1

[Kieran Sedgwick (:sedge)]

Attachment: README updates | https://github.com/mozilla/login.webmaker.org/pull/211

First swing at the readme, with updated API and ENV reference.

Comment 2

[Pomax]

Comment on attachment 8339455 [details] [review]
README updates | https://github.com/mozilla/login.webmaker.org/pull/211

r-, but not because of reasons, per se. I'm mostly curious what the tone you're trying to set is, so I can do a proper proofing with that in mind. The readme skips from formal to informal to API documentation, which makes it hard to internalise as a single document.

On a different note, this is JavaScript, not C, and it's documentation, so we don't need to abbreviate things like "boolean" to "bool" =)

Also, how far do I need to go in this readme? It looks like a lot is dumping ground pending rewrite.

Comment 3

[David Humphrey (:humph)]

Comment on attachment 8339455 [details] [review]
README updates | https://github.com/mozilla/login.webmaker.org/pull/211

Clearing my review until Pomax's issues are dealt with.  Re-flag me after that.

Comment 4

[Kieran Sedgwick (:sedge)]

Attachment: https://github.com/mozilla/login.webmaker.org/wiki/LoginAPI-&-User-Model

I factored a bunch of information out of the README in order to focus it. I decided on putting it into the Github wiki for the Login repo, and this is the first page I updated.

Comment 5

[Kieran Sedgwick (:sedge)]

Attachment: https://github.com/mozilla/login.webmaker.org/wiki/ENV-File-Reference

Comment 6

[Kieran Sedgwick (:sedge)]

Attachment: https://github.com/mozilla/login.webmaker.org/wiki/Integration-guide-for-new-apps

Comment 7

[Kieran Sedgwick (:sedge)]

Comment on attachment 8339455 [details] [review]
README updates | https://github.com/mozilla/login.webmaker.org/pull/211

Another look? You rock!

Comment 8

[Pomax]

Comment on attachment 8341895 [details]
https://github.com/mozilla/login.webmaker.org/wiki/LoginAPI-&-User-Model

can we make these .md pages in a docs dir so they can be commented on as a PR? There's a number of things I'd like to comment on but due to the wiki style, cannot currently do.

Comment 9

[Pomax]

Comment on attachment 8339455 [details] [review]
README updates | https://github.com/mozilla/login.webmaker.org/pull/211

comments in the PR

Comment 10

[Pomax]

Comment on attachment 8341896 [details]
https://github.com/mozilla/login.webmaker.org/wiki/ENV-File-Reference

as a non-PR, I have no place to leave actual comments per line.

Comment 11

[Pomax]

Comment on attachment 8341897 [details]
https://github.com/mozilla/login.webmaker.org/wiki/Integration-guide-for-new-apps

as a non-PR, I have no place to leave actual comments per line.

Comment 12

[Kieran Sedgwick (:sedge)]

Comment on attachment 8339455 [details] [review]
README updates | https://github.com/mozilla/login.webmaker.org/pull/211

I added the pages as .MD files per your request.

Comment 13

[Pomax]

Comment on attachment 8339455 [details] [review]
README updates | https://github.com/mozilla/login.webmaker.org/pull/211

notes in the PR

Comment 14

[Kieran Sedgwick (:sedge)]

Comment on attachment 8339455 [details] [review]
README updates | https://github.com/mozilla/login.webmaker.org/pull/211

Thanks for working with me on this. Long live docs!

Comment 15

[Pomax]

Comment on attachment 8339455 [details] [review]
README updates | https://github.com/mozilla/login.webmaker.org/pull/211

r+ with API styling as a "you may want to find a nice styling based on what other projects on github do", but it's not enough to hold up the review really.

Comment 16

[Jon Buckley [:jbuck]]

:sedge - ping

Comment 17

[Kieran Sedgwick (:sedge)]

This bug is on pause until :cade's reference implementation of the new Login auth system is complete.

Comment 18

[Chris DeCairos (:cade)]

I'm closing this bug as part of the planned deprecation of the Webmaker component on Bugzilla.

If this issue is still in need of fixing, you can file it on Github, where we track login related issues for Thimble.

https://github.com/mozilla/login.webmaker.org
https://github.com/mozilla/id.webmaker.org