[Freeswitch-docs] Conference Page
Folks, Any special reason for keeping this page? https://freeswitch.org/confluence/display/FREESWITCH/Conference Looks like we're pointing it to mod_conference and it only contains examples, we can concentrate this in the mod_conference page. -- Ítalo Rossi
yes, looks odd where it is now. There's also a separate section with examples, https://freeswitch.org/confluence/display/FREESWITCH/Examples so we can place them there, and link from mod_conference On Thu, Jul 9, 2015 at 10:20 PM, Ítalo Rossi <italorossib@gmail.com> wrote:
Folks,
Any special reason for keeping this page?
https://freeswitch.org/confluence/display/FREESWITCH/Conference
Looks like we're pointing it to mod_conference and it only contains examples, we can concentrate this in the mod_conference page.
-- Ítalo Rossi
_______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
On 9 July 2015 at 22:33, Stanislav Sinyagin <ssinyagin@gmail.com> wrote:
yes, looks odd where it is now. There's also a separate section with examples, https://freeswitch.org/confluence/display/FREESWITCH/Examples so we can place them there, and link from mod_conference
IMO, an entire page for examples is a good idea. The examples may be duplicated in both the article about the example and in it's own section, but if there's one place users can go to get a good example, that's good. -- ------- inum: 883510009027723 sip: jungleboogie@sip2sip.info xmpp: jungle-boogie@jit.si
Duplication is the enemy. It's too easy for an example on one page to be updated while another example is forgotten or worse, modified separately with no version control to keep the duplicates in sync. I haven't finished what I started on the original conference page because the latest FS release is focused so heavily on video conferencing that there are tons of changes associated with that whole module and Mike and others wrote extensive changes to the docs for it. Bote
-----Original Message----- From: freeswitch-docs-bounces@lists.freeswitch.org [mailto:freeswitch- docs-bounces@lists.freeswitch.org] On Behalf Of jungle Boogie Sent: Friday, 17 July, 2015 10:16 To: FreeSWITCH Docs Team Subject: Re: [Freeswitch-docs] Conference Page
On 9 July 2015 at 22:33, Stanislav Sinyagin <ssinyagin@gmail.com> wrote:
yes, looks odd where it is now. There's also a separate section with examples, https://freeswitch.org/confluence/display/FREESWITCH/Examples so we can place them there, and link from mod_conference
IMO, an entire page for examples is a good idea. The examples may be duplicated in both the article about the example and in it's own section, but if there's one place users can go to get a good example, that's good.
-- ------- inum: 883510009027723 sip: jungleboogie@sip2sip.info xmpp: jungle-boogie@jit.si
_______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
-1 for Duplication. What we probably want is that every code example must have an 'example' tag in it, so we can easily find all the examples using the tag browser (https://freeswitch.org/confluence/label/FREESWITCH/examples ). We should really talk about which items should be in the main root tree, there's some odd things that I really dislike and give others an impression that things is not well organized. A good example is that we have the Configuring section and if you look at the bottom you'll see "Configuration OpenZAP - DigiumTDM400P Example". This page should be under the Configuring section and probably a sub section of TDM Cards, or something like that. That's just an example. Another one is https://freeswitch.org/confluence/display/FREESWITCH/Creating+RPM+repositary . I also would remove Index, Corrections and Old Wiki and Release Process from the main tree and put them in they appropriate section. We need to 'refactor' the first page with a new user perspective, what they need to know first and what's the best flow to learn FreeSWITCH? Just thoughts... On Fri, Jul 17, 2015 at 11:31 AM, Bote Man <bote_radio@botecomm.com> wrote:
Duplication is the enemy.
It's too easy for an example on one page to be updated while another example is forgotten or worse, modified separately with no version control to keep the duplicates in sync.
I haven't finished what I started on the original conference page because the latest FS release is focused so heavily on video conferencing that there are tons of changes associated with that whole module and Mike and others wrote extensive changes to the docs for it.
Bote
-----Original Message----- From: freeswitch-docs-bounces@lists.freeswitch.org [mailto:freeswitch- docs-bounces@lists.freeswitch.org] On Behalf Of jungle Boogie Sent: Friday, 17 July, 2015 10:16 To: FreeSWITCH Docs Team Subject: Re: [Freeswitch-docs] Conference Page
On 9 July 2015 at 22:33, Stanislav Sinyagin <ssinyagin@gmail.com> wrote:
yes, looks odd where it is now. There's also a separate section with examples, https://freeswitch.org/confluence/display/FREESWITCH/Examples so we can place them there, and link from mod_conference
IMO, an entire page for examples is a good idea. The examples may be duplicated in both the article about the example and in it's own section, but if there's one place users can go to get a good example, that's good.
-- ------- inum: 883510009027723 sip: jungleboogie@sip2sip.info xmpp: jungle-boogie@jit.si
_______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
_______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
-- Ítalo Rossi
Oh, I agree %100000 that organization is key and much needed. Remember, the outline tree in the left pane is easily changeable by drag-and-drop for editors, so I haven’t been too worried about that. When I see new pages pop up at the top level that belong elsewhere I just move them, but that is strictly a visual thing. The link to the page remains constant wherever it appears in the outline. Tags / labels are your friend, true. I have tagged pages with “Example” if they have even one example, but maybe a separate page containing examples is better for some pages? I think I moved the “Old Wiki” link to the top of the outline tree so that people would know to search there in case the page they want had not been moved over. For myself, I have not touched the new work because you and others have done so much lately that I don’t have a good grasp of it and I absolutely do not want to mess up what is currently under active editing. This is Good Stuff. Thanks. Bote From: Ítalo Rossi Sent: Friday, 17 July, 2015 11:26 To: FreeSWITCH Docs Team Subject: Re: [Freeswitch-docs] Conference Page -1 for Duplication. What we probably want is that every code example must have an 'example' tag in it, so we can easily find all the examples using the tag browser (https://freeswitch.org/confluence/label/FREESWITCH/examples). We should really talk about which items should be in the main root tree, there's some odd things that I really dislike and give others an impression that things is not well organized. A good example is that we have the Configuring section and if you look at the bottom you'll see "Configuration OpenZAP - DigiumTDM400P Example". This page should be under the Configuring section and probably a sub section of TDM Cards, or something like that. That's just an example. Another one is https://freeswitch.org/confluence/display/FREESWITCH/Creating+RPM+repositary. I also would remove Index, Corrections and Old Wiki and Release Process from the main tree and put them in they appropriate section. We need to 'refactor' the first page with a new user perspective, what they need to know first and what's the best flow to learn FreeSWITCH? Just thoughts... On Fri, Jul 17, 2015 at 11:31 AM, Bote Man <bote_radio@botecomm.com> wrote: Duplication is the enemy. It's too easy for an example on one page to be updated while another example is forgotten or worse, modified separately with no version control to keep the duplicates in sync. I haven't finished what I started on the original conference page because the latest FS release is focused so heavily on video conferencing that there are tons of changes associated with that whole module and Mike and others wrote extensive changes to the docs for it. Bote
-----Original Message----- From: freeswitch-docs-bounces@lists.freeswitch.org [mailto:freeswitch- docs-bounces@lists.freeswitch.org] On Behalf Of jungle Boogie Sent: Friday, 17 July, 2015 10:16 To: FreeSWITCH Docs Team Subject: Re: [Freeswitch-docs] Conference Page
On 9 July 2015 at 22:33, Stanislav Sinyagin <ssinyagin@gmail.com> wrote:
yes, looks odd where it is now. There's also a separate section with examples, https://freeswitch.org/confluence/display/FREESWITCH/Examples so we can place them there, and link from mod_conference
IMO, an entire page for examples is a good idea. The examples may be duplicated in both the article about the example and in it's own section, but if there's one place users can go to get a good example, that's good.
-- ------- inum: 883510009027723 sip: jungleboogie@sip2sip.info xmpp: jungle-boogie@jit.si
_______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs
_______________________________________________ Freeswitch-docs mailing list Freeswitch-docs@lists.freeswitch.org http://lists.freeswitch.org/mailman/listinfo/freeswitch-docs -- Ítalo Rossi
participants (4)
-
Bote Man
-
jungle Boogie
-
Stanislav Sinyagin
-
Ítalo Rossi