freeswitch-docs icon indicating copy to clipboard operation
freeswitch-docs copied to clipboard

Remove deprecated modules

Open hey-august opened this issue 7 months ago • 6 comments

Process

Docs for each of the following FreeSWITCH modules should be deleted, as the modules have been deprecated.

  1. Remove the module page.
  2. Check for links to the module page.
    • To do this, search the repository for the filename of the deleted page. For example: mod_portaudio_9634724.mdx
    • If the link can be safely removed with no impact to its host page, remove the link.
    • If not, make a note in the PR and a maintainer will review.
  3. Create one PR for each module.

List of deprecated modules

mod_skypopen
mod_gsmopen
mod_sangoma_codec
mod_ladspa
mod_cepstral
mod_sms_flowroute
mod_dahdi_codec
mod_portaudio, mod_portaudio_stream
mod_mp4, mod_mp4v, mod_mp4v2
mod_isac
mod_abstraction
mod_stress
mod_unicall
mod_soundtouch
mod_sonar
mod_snom
mod_rss
mod_raven
mod_radius_cdr
mod_xml_radius
mod_rad_auth
mod_khomp
mod_h26x
mod_event_zmq
mod_theora
mod_yaml
mod_oreka
mod_clearmode
move tts format to mod_dptools
mod_ssml, mod_rayo, iksemel

Related issue

#11345 (private repo)

hey-august avatar Apr 17 '25 15:04 hey-august

Happy to work on this issue this week!

jeromefv avatar Apr 17 '25 17:04 jeromefv

I'm working on #193 and #194 .

andpersand avatar May 04 '25 16:05 andpersand

I'll do issues 196,197,204,205,~206~ Status: DONE ✅

the-star-thrower avatar May 04 '25 16:05 the-star-thrower

Doing 208, 209, 210, 218

JessamyT avatar May 04 '25 17:05 JessamyT

Would it be advisable to move the deprecated module pages to a separate archive area, rather than delete them? TNX.

boteman avatar May 04 '25 19:05 boteman

@boteman this is a good question! I asked @briankwest , who is a core maintainer for FreeSWITCH, and he said it was OK just to remove - probably since many of these modules have been deprecated for quite a long time. The old pages will still be available in version control if they were ever needed in the future. We could consider adding a simple list of "deprecated modules" list somewhere in the modules reference.

TL;DR, we do really want to delete the files.

hey-august avatar May 04 '25 20:05 hey-august