[asterisk-dev] [Code Review] 4328: res_pjsip: Document transport selection process

[Joshua Colp]

> On Jan. 12, 2015, 5:32 p.m., rnewton wrote:
> > It looks detailed enough for me.
> > 
> > One thing I might change would be some of the headings and the page title. 
> > 
> > You have a couple sub-headings reading " PJSIP Transport Selection", whereas the others do not mention PJSIP. When you find one of our wiki pages via google, the page title shows up as the dominant text in both the search result and it is included in the URL.  If I understand the page then the whole page concerns transport selection for PJSIP. I would title the page "PJSIP Transport selection" and not worry about stating that in the sub-headings, or else use it consistently throughout the sub-headings as well as adding "PJSIP" to the title.
> > 
> > You could also link some keywords to other content on the wiki. That is always helpful in-case someone lands on this page but they are not aware of some other helpful content related to the topic.
> > 
> > Otherwise, ship it!
> 
> rnewton wrote:
>     Oh! Add the standard Table of Contents format that we use. See the "General Asterisk Wiki Page" template for an example.

Mad props to rnewton for crushing Confluence with his will.


- Joshua


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/4328/#review14158
-----------------------------------------------------------


On Jan. 12, 2015, 1:33 p.m., Joshua Colp wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/4328/
> -----------------------------------------------------------
> 
> (Updated Jan. 12, 2015, 1:33 p.m.)
> 
> 
> Review request for Asterisk Developers.
> 
> 
> Repository: Asterisk
> 
> 
> Description
> -------
> 
> The transport selection process of PJSIP (and by extension some of our own logic) can be a dark dark thing. To help illuminate what happens I have created a wiki page[1] which goes through (based on the message type) the process by which a transport is chosen and how it can potentially change.
> 
> Stuff to look at:
> 1. Is this detailed enough?
> 2. Can you follow it? If not, how could it be made clearer?
> 3. Are there additional common issues that should be covered?
> 
> [1] https://wiki.asterisk.org/wiki/display/~jcolp/Transport+Selection
> 
> 
> Diffs
> -----
> 
> 
> Diff: https://reviewboard.asterisk.org/r/4328/diff/
> 
> 
> Testing
> -------
> 
> I opened the wiki page. It opened.
> 
> 
> Thanks,
> 
> Joshua Colp
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20150112/c38dbad5/attachment.html>