ossrs/srs-docs

The documents for SRS

srs-docs's Issues

文档路径需要保持一致，国内和国外网站中中文都应该包含 zh-cn，英文都应该包含 en-us

现在路径这块是否能不默认呢？比如，中文是：
http://ossrs.io/zh-cn/docs/doc/git

英文是：
http://ossrs.io/docs/doc/git

能否格式统一成：
http://ossrs.io/en-us/docs/doc/git

因为有可能会贴这个路径，有时候要贴两个，但他们却不一样。

需要达到的效果是同一个文档的四个路径应该如下：

• http://ossrs.io/en-us/docs/doc/git
• http://ossrs.io/zh-cn/docs/doc/git
• http://ossrs.net/lts/en-us/docs/doc/git
• http://ossrs.net/lts/zh-cn/docs/doc/git
  同时需要注意，页面中的切换语言按钮需要能够跳转到正确的路径上

Search: can not search amf0_spec_121207.pdf

在https://ossrs.io/lts/en-us/docs/v4/tools/specs路径下，点击搜索框，搜索文档amf0无结果显示

开放接口HTTP Callback 无内容，点击编辑此页跳转404

应该链接此页面 v4_CN_HTTPCallback

许可证对应错误

SRS和SRS Stack的许可证相互搞反了

X509 Certification not valid for www.ossrs.io in Safari

Env

MacOS Safari and Chrome web browser.

Bug description

open https://www.ossrs.io/lts/en-us/ in safari web browser. It will said This Connection is Not Private.
open https://www.ossrs.io/lts/en-us/ in chrome web browser. It will redirect to https://ossrs.io/lts/en-us/, and from the DevTools, a message print:

Redirecting navigation www.ossrs.io -> ossrs.io because the server presented a certificate valid for ossrs.io but not for www.ossrs.io. To disable such redirects launch Chrome with the following flag: --disable-features=SSLCommonNameMismatchHandling

Same issue also exists in [https://www.ossrs.net/lts/zh-cn/](https://www.ossrs.net/lts/zh-cn/), but ossrs.net is worse, because I search keyword srs transcode in bing.com, the result would list in www.ossrs.net instead of ossrs.net.

Because https://github.com/ossrs/ossrs.net has not entry to send an issue, so I sent issue here.

Cause

the ossrs.io & ossrs.net 's x590 certification is not cover the www.ossrs.io & www.ossrs.net domain, and the server also support the access to www.ossrs.[io|net] space. And Safari web browser don't support redirection to the certification validated address.

sidebar_label: Reuse Port

TCP SO_REUSEPORT功能，建议修改下对应的侧边栏标签Reuser Port

./for-writers/doc-zh-5.0/doc/reuse-port.md:2:title: Reuser Port
./for-writers/doc-zh-5.0/doc/reuse-port.md:3:sidebar_label: Reuser Port
./for-writers/doc-zh-4.0/doc/reuse-port.md:2:title: Reuser Port
./for-writers/doc-zh-4.0/doc/reuse-port.md:3:sidebar_label: Reuser Port
./i18n/zh-cn/docusaurus-plugin-content-docs/current/doc/reuse-port.md:2:title: Reuser Port
./i18n/zh-cn/docusaurus-plugin-content-docs/current/doc/reuse-port.md:3:sidebar_label: Reuser Port
./i18n/zh-cn/docusaurus-plugin-content-docs/version-4.0/doc/reuse-port.md:2:title: Reuser Port
./i18n/zh-cn/docusaurus-plugin-content-docs/version-4.0/doc/reuse-port.md:3:sidebar_label: Reuser Port

Blog列表是否改成标题，全部列出来太多了

目前Blog是默认把文章展示出来，一个接一个的，而不是只展示标题和摘要，如果文章太多会没法看了。

英文 4.0 版本 docs 文件需要放到 i18n 目录中

目前的 docs 目录文件位置：

• 英文 current 版本 docs 文件: <root_dir>/i18n/en-us/docusaurus-plugin-content-docs/current
• 英文 4.0 版本 docs 文件: <root_dir>/versioned_docs/version-4.0
• 中文 current 版本 docs 文件: <root_dir>/i18n/zh-cn/docusaurus-plugin-content-docs/current
• 中文 4.0 版本 docs 文件: <root_dir>/i18n/zh-cn/docusaurus-plugin-content-docs/version-4.0

需要配置 versioned_docs 目录位置

versioned docs 文件中没有中文文件

versioned docs 文件中只有英文，需要明确中文文件如何备份

srs.wiki与zh-cn/en-us文档同步

• 如何讲srs.wiki目录下各个版本的md文件分散到srs-docs不同版本的中英文目录下

  • 比如git clone https://github.com/ossrs/srs.wiki.git后，
    • 将v4_EN_Edge.md对应存放到versioned_docs/version-4.0/doc/目录下
    • 将v4_CN_Edge.md对应存放到i18n/zh-cn/docusaurus-plugin-content-docs/version-4.0/doc/目录下
    • 假如以后补充了5.0的wiki, 需要将
      • 将v5_EN_Edge.md对应存放到i18n/en-us/docusaurus-plugin-content-docs/current/doc/目录下
      • 将v5_CN_Edge.md对应存放到i18n/zh-cn/docusaurus-plugin-content-docs/current/doc/目录下
    • srs.wiki需保证每一个文件，对应的中英文文件都存在

• 当srs.wiki更新后，如何将对应文件的修改同步到srs-docs对应的文件

  • 在srs.wiki更新后，可能需要在srs-docs记录之前同步的commit信息，并与srs.wiki进行diff检查
    • 修改文件，则将修改后的文件直接同步到对应目录
    • 增加文件，则需要将文件拷贝到对应目录，并修改sidebar.js, 以及write-translations
    • 删除文件，则需要将对应文件从doc目录中删除，并修改sidebar.js, 以及write-translations

current 版本和 next 版本的 url 路径需要固定下来，防止链接失效

目前的情况

4.0 的 url 格式：https://ossrs.io/lts/en-us/docs/doc/introduction
5.0 的 url 格式：https://ossrs.io/lts/en-us/docs/next/doc/introduction

需要实现的效果如下

4.0 的 url 格式：https://ossrs.io/lts/en-us/docs/v4/doc/introduction
5.0 的 url 格式：https://ossrs.io/lts/en-us/docs/v5/doc/introduction