signalserver icon indicating copy to clipboard operation
signalserver copied to clipboard

Published 20 hours ago • verified publisher icon bavc

Documentation on how to use SignalServer

Open ablwr opened this issue 7 years ago • 16 comments

Needed!

ablwr avatar May 16 '17 03:05 ablwr

@lbjohnson01 I will assign this to you, based on convo in #251. I'd prefer the opportunity to work in the open as much as possible -- do you prefer...

1 working in a public google doc we can link here, and then migrating the whole thing over in one large git commit after we go through approval rounds
2 making small, gradual commits and comments in a github branch, and then merging when all approved?

ablwr avatar May 16 '17 16:05 ablwr

Thanks - I think no. 1 would be better. Lol as we know, I tried something like no. 2 last time and that ended up being an epic fail. Would you start the doc?​

lbjohnson01 avatar May 16 '17 20:05 lbjohnson01

It was not a fail!

ablwr avatar May 16 '17 20:05 ablwr

I made a mostly-empty document here! https://docs.google.com/document/d/13vBTPgZY-ehR2Ej_aM7s7xdYCXfnf8DTeJB4zdOUpmo/edit?usp=sharing

ablwr avatar May 16 '17 20:05 ablwr

Thanks! :)

Or you could tell me all the parameters we want covered, and I'll start the doc. ​

lbjohnson01 avatar May 16 '17 20:05 lbjohnson01

I'll work on making some outlines later tonight.

ablwr avatar May 16 '17 20:05 ablwr

Whoops, I updated the link above, please use the most recent link.

ablwr avatar May 16 '17 20:05 ablwr

Got it thanks! ​

lbjohnson01 avatar May 16 '17 21:05 lbjohnson01

ping ping, anything else I can do to help this get started?

ablwr avatar May 23 '17 14:05 ablwr

How's this coming along? Do you need anything from me?

ablwr avatar May 30 '17 16:05 ablwr

Hi Ashley, thanks for the pings - just now saw the May 23 one, so I'm sorry I didn't get back to you sooner! yes, I'm putting it together and it should be up tomorrow for review and input, rec's, etc.​

lbjohnson01 avatar May 30 '17 20:05 lbjohnson01

I think we should have documentation on the site for usage but we should also work on shaping up the documentation that exists in the README -- and also spend some time thinking about what the differences are, and making sure we link between the two. Can that be encompassed in this ticket, or should a new ticket be created?

ablwr avatar Jul 11 '17 13:07 ablwr

It makes sense to me to start a new ticket. For the moment I've got both going in the working site usage document to have them in one place but perhaps it's best to also separate it out into separate working documents as well.

​

lbjohnson01 avatar Jul 11 '17 13:07 lbjohnson01

I would like to see a draft of this added to the next version of Signal Server. @lbjohnson01 just ping me when the doc is ready for migration!

ablwr avatar Jul 17 '17 20:07 ablwr

Is this ready?

ablwr avatar Jul 30 '17 14:07 ablwr

We're still working through it. I'll let you know when it's solidified

iamdamosuzuki avatar Jul 31 '17 18:07 iamdamosuzuki