diff --git a/.gitignore b/.gitignore index b2d6de30..0fe0bf7b 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,5 @@ npm-debug.log* yarn-debug.log* yarn-error.log* +yarn.lock + diff --git a/README.md b/README.md index 8acc8ac8..a5a956db 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ -# FreeSWITCH Documentation +# RTS 文档 -This repository contains the documentation for FreeSWITCH, published at https://developer.signalwire.com/freeswitch. +This repository contains the documentation for RTS - Real-Time Server, published at http://rts.cn/docs/. ## Instructions for contributors + ### Installation ``` @@ -28,8 +29,8 @@ This command generates static content into the `build` directory and can be serv ### Building the Docker image ``` -$ docker build -t freeswitch-docs . -$ docker run --rm -it -p 8080:80 freeswitch-docs +$ docker build -t rts-docs . +$ docker run --rm -it -p 8080:80 rts-docs ``` -The site will be available on port 8080 on your local machine. \ No newline at end of file +The site will be available on port 8080 on your local machine. diff --git a/algolia.json b/algolia.json index 811fc7a9..995c12c8 100644 --- a/algolia.json +++ b/algolia.json @@ -1,8 +1,8 @@ { "index_name": "freeswitch-docs", - "start_urls": [{ "url": "https://developer.signalwire.com/freeswitch" }], - "stop_urls": ["https://developer.signalwire.com/freeswitch/Channel-Variables-Catalog/.*"], - "sitemap_urls": ["https://developer.signalwire.com/freeswitch/sitemap.xml"], + "start_urls": [{ "url": "http://rts.cn/docs" }], + "stop_urls": ["http://rts.cn/docs/Channel-Variables-Catalog/.*"], + "sitemap_urls": ["http://rts.cn/sitemap.xml"], "sitemap_alternate_links": true, "selectors": { "default": { diff --git a/docs/about/mirror.mdx b/docs/about/mirror.mdx deleted file mode 100644 index 84a5a68c..00000000 --- a/docs/about/mirror.mdx +++ /dev/null @@ -1,7 +0,0 @@ -# About This Mirror - -This is a Mirror of the [Official FreeSWITCH Docs](https://developer.signalwire.com/freeswitch/)。 - -Updates and Pull Requests please go to the [Offical FreeSWITCH Documentation Github Repo](https://github.com/signalwire/freeswitch-docs)。 - -This mirror is **Manually** synced from the Official FreeSWITCH Docs Repo and maybe behind. diff --git a/docs/about/rts.mdx b/docs/about/rts.mdx new file mode 100644 index 00000000..f42ded2c --- /dev/null +++ b/docs/about/rts.mdx @@ -0,0 +1,3 @@ +# 关于RTS + +RTS是一个FreeSWITCHFreeSWITCH衍生版,开源,由RTS社区维护。 diff --git a/docs/rts/faq.mdx b/docs/rts/faq.mdx new file mode 100644 index 00000000..3ab80ea7 --- /dev/null +++ b/docs/rts/faq.mdx @@ -0,0 +1,54 @@ +# FAQ + +RTS 常见问题。 + +## 什么是 RTS? + +RTS is a Derivative work of FreeSWITCH, Not a Fork。 + +RTS 是一个 FreeSWITCH 衍生品,不是一个 Fork。 + +RTS 旨在解决但不限于以下问题: + +- 稳定的发行版 +- 更实用的默认配置 +- 更多的 Feature +- 国产化适配 +- 更好的控制接口 +- UI +- 还有好多 + +RTS 期待: + +- 更多的用户 +- 更多的贡献者 + +## 为什么做 RTS? + +我们为 FreeSWITCH 做了很多贡献,我们也会一如即往地做贡献。跟所有开源软件一样,开源软件其实鼓励做衍生品。 + +我们希望能提供更好的能力,解决用户在使用 FreeSWITCH 中的问题: + +## 目前你们已经做了哪些工作? + +- [RTS 仓库](https://github.com/rts-cn/rts) +- 你看到的这些文档 +- 持续更新中 ... + +## Github 访问比较困难,有没有国内镜像? + +我们会做一个国内镜像。 + +## 目前都有哪些人加入? + +- 杜老师 Seven Du +- 大熊 +- 鼎鼎 + +## 如何加入你们? + +到[我们的讨论区](https://github.com/rts-cn/rts/discussions)讨论,未来我们会提供更多的联系方式。 + +## 更多问题? + +[欢迎提出](https://github.com/rts-cn/rts/discussions)。 diff --git a/docs/rts/index.mdx b/docs/rts/index.mdx new file mode 100644 index 00000000..409ff546 --- /dev/null +++ b/docs/rts/index.mdx @@ -0,0 +1,19 @@ +# RTS : RTS + +欢迎使用RTS。 + +## 什么是RTS? + +RTS是一个实时解决方案,也是一个实时SIP服务器。包含两个部分:rtss(RTS Server)和 rts (RTS客户端)。 + +- RTS 是一个FreeSWITCH 衍生版。 +- 有稳定的发行版。 +- 开源。 +- 最大程度兼容FreeSWITCH。 +- 有自己的Bug修复和扩展。 + +## 其他 + +如果你还有问题,可以看一下[RTS FAQ](faq) + +RTS是一个FreeSWITCH 衍生版。现在文档还比较少,可以先看看[FreeSWITCH文档](/FreeSWITCH-Explained/)。 diff --git a/docusaurus.config.js b/docusaurus.config.js index 07ec0b63..57a0e76b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -6,13 +6,13 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula"); /** @type {import('@docusaurus/types').Config} */ const config = { - title: "FreeSWITCH Documentation", - tagline: "This is a MIRROR", - url: "https://developer.signalwire.com", - baseUrl: "/freeswitch/", + title: "RTS 文档", + tagline: "Real-Time SIP Server", + url: "http://rts.cn", + baseUrl: "/docs/", onBrokenLinks: "warn", onBrokenMarkdownLinks: "warn", - favicon: "img/favicon.webp", + favicon: "img/favicon.ico", // Even if you don't use internalization, you can use this field to set useful // metadata like html lang. For example, if your site is Chinese, you may want @@ -32,7 +32,7 @@ const config = { routeBasePath: "/", // Please change this to your repo. // Remove this to remove the "edit this page" links. - editUrl: "https://github.com/signalwire/freeswitch-docs/tree/main/", + editUrl: "https://github.com/rts-cn/docs/tree/main/", }, blog: false, theme: { @@ -48,30 +48,34 @@ const config = { navbar: { //title: "FreeSWITCH Documentation", logo: { - alt: "FreeSWITCH Documentation", - src: "img/logo.svg", + alt: "RTS 文档", + src: "img/rts.svg", }, items: [ + { + href: "/docs/rts", + label: "RTS文档", + }, { type: "doc", docId: "FreeSWITCH-Explained/index", position: "left", - label: "FreeSWITCH Explained", + label: "FreeSWITCH文档", }, { type: "doc", docId: "Channel-Variables-Catalog/index", position: "left", - label: "Variables", - }, - { - href: "https://developer.signalwire.com/guides", - label: "SignalWire", - position: "left", - target: "_self", + label: "通道变量", }, + // { + // href: "https://developer.signalwire.com/guides", + // label: "SignalWire", + // position: "left", + // target: "_self", + // }, { - href: "https://github.com/signalwire/freeswitch", + href: "https://github.com/rts-cn/rts", label: "GitHub", position: "right", }, @@ -82,36 +86,24 @@ const config = { style: "dark", links: [ { - title: "Video", + title: "关于", items: [ { - label: "Youtube", - href: "https://www.youtube.com/freeswitch", - }, - { - label: "About", - to: "/about/mirror", - }, - { - label: "Tutorial", - to: "/docs/intro", - }, - { - label: "Official Docs", - to: "https://developer.signalwire.com/freeswitch/", + label: "关于", + to: "/about/rts", }, + // { + // label: "Tutorial", + // to: "/docs/intro", + // }, ], }, { - title: "Community", + title: "社区", items: [ { - label: "Forums", - href: "https://forum.signalwire.community/", - }, - { - label: "Twitter", - href: "https://twitter.com/freeswitch", + label: "讨论", + href: "https://github.com/rts-cn/rts/discussions", }, { label: "FreeSWITCH中文", @@ -120,15 +112,11 @@ const config = { ], }, { - title: "More", + title: "更多", items: [ - { - label: "Cluecon", - href: "https://www.cluecon.com/", - }, { label: "GitHub", - href: "https://github.com/signalwire/freeswitch", + href: "https://github.com/rts-cn/rts", }, { label: "RTS Home", @@ -147,10 +135,10 @@ const config = { theme: lightCodeTheme, darkTheme: darkCodeTheme, }, - algolia: { - appId: "2NBPM6ETKJ", - apiKey: "4489aa468117b5bfbcb83f7b0addddc9", - indexName: "freeswitch-docs", + xalgolia: { + appId: "xxxxxx", + apiKey: "xxxxxx", + indexName: "rts-docs", externalUrlRegex: `.*`, /** * We need to set this to false, otherwise the query is done with diff --git a/src/pages/index.js b/src/pages/index.js index 48ff8aa5..af76e153 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -16,9 +16,9 @@ function HomepageHeader() {