Docs: Rewrite ossrs.net, rewriting official website documentation

winlinvip commented 2 years ago

In the past few days, I've gone through react.org and finished reading "The Cathedral and the Bazaar". I've realized the difference between Chinese open source and international open source, which is approximately about 30 years. I hope that when I'm around 70 years old, I will be able to see the Chinese open source community reach the level of the foreign one today.

It is still important to steadfastly stand in one's own position and do one's own tasks well. The SRS document is considered quite good in the open source and even commercial products in China. Its level of activity isn't far off from react.org. However, it is worth noting that the comparison is mainly regarding the activity level of the documentation project, not yet the objective of react. Hahaha.

As a newcomer to React, after reading through react.org, I have gained a good understanding of what React can do, what it entails, what I may not currently need, what I haven't fully grasped yet, and how to contribute if I want to. It's no wonder that there are many participants, as the community has a low entry barrier.

If the previous goal of SRS was to be a highly functional audio-video server and reduce the barrier for audio-video developers to set up servers, then my core work for the next decade will be to lower the entry barrier for the community. I want to make it easy for everyone to participate in open source, easily understand this project, and not just lower the usage threshold but also the participation threshold.

I plan to restructure and rewrite the documentation for SRS 5.0.

Mainly, I will be studying react.org, bootstrap, react-bootstrap, and node.

The official website has become documentation with its own independent repository, automatic integration and release.
Multiple languages are divided into different sub-projects, referring to en and cn.
React does not support multiple versions, referring to reactjs.org#85, and can refer to the version-based documentation of nodejs, which is also important. The documentation for nodejs is in the code repository node.
Tutorials and documentation need to be separated. Tutorials provide users with a quick understanding through typical scenarios, while docs provide developers with documentation from beginner to mastery. React's documentation does this quite well.
The official website and documentation of Bootstrap are also very good, and they have version-based documentation. However, its official website is not as simple as React's, with more entry points, which may be because Bootstrap offers more functionality.
React-bootstrap and Bootstrap have left navigation and in-page navigation, where the left side serves as the overall table of contents and the right side acts as the in-page table of contents, which is quite reasonable.
Both reactjs.org and Bootstrap have documentation search capabilities using Algolia, including support for Chinese, as seen in zh-hans.reactjs.org.
GitHub Docs GitHub's documentation is actually very good, but generally, fewer systems read it, usually checking it when there are issues.
Redis.io Redis' official website is also simple and clear, and is written very well.

TRANS_BY_GPT3

ghostsf commented 2 years ago

support

TRANS_BY_GPT3

firemakergk commented 2 years ago

I am a programmer with 7 years of experience. Yesterday, I discovered SRS and I was very excited. But when I started trying it out, I found myself going around in circles on the wiki and couldn't get the hang of it. The recommended Bilibili video was a paid course. I must say that the documentation for this project does not live up to its quality. I am delighted to see that the author is starting to pay attention to the documentation quality.

TRANS_BY_GPT3

zhOrange commented 2 years ago

Truly amazing!

TRANS_BY_GPT3

winlinvip commented 2 years ago

I am a programmer with 7 years of experience. Yesterday, I discovered SRS and was very excited. However, when I started to try it out, I found myself going around in circles on the wiki and unable to get started. The recommended Bilibili videos are paid courses. It can be said that the documentation of this project does not match its quality. I am glad to see that the author is now paying attention to the quality of the documentation.

Buddy, did you spend those seven years on PHP, haha.

TRANS_BY_GPT3

firemakergk commented 2 years ago

I am a programmer with 7 years of experience. I discovered SRS yesterday and I was very excited. However, when I started trying it out, I found myself going around in circles on the wiki and couldn't figure out how to get started. The recommended B station video is a paid course. I can say that the documentation for this project does not match its quality. I am glad to see that the author has started to prioritize documentation quality.

Bro, did you spend those seven years on PHP, haha!

Bro, maybe you didn't mean it, but it sounds a bit arrogant.

TRANS_BY_GPT3

winlinvip commented 2 years ago

Hey bro, maybe you didn't mean it, but it came off a bit arrogant.

Hmm, sorry sorry. Is it really that difficult for audio and video? Could it be a lack of time investment?

Seeing everyone so excited about the new documentation, it's a bit different from what I had in mind. The new documentation may not have such a significant impact, and the process of going from 70 to 80 marks may disappoint everyone.

TRANS_BY_GPT3

sureone commented 2 years ago

After about a week of trial and error using the tutorial on the official website's wiki, I successfully deployed a test environment for gb28181. The most remarkable thing is the all-in-one package of the source code, which can be built and used without downloading other dependency libraries. I give you a thumbs up and feel proud of Chinese programmers for creating such excellent open source projects. I hope you can continue to improve and keep up the good work! I hope to have a chance to contribute as well.

TRANS_BY_GPT3

xiaosongxiaosong commented 2 years ago

I recommend using Docusaurus to write the documentation. It is written in markdown and supports multiple languages, versions, and search functionalities. @winlinvip

TRANS_BY_GPT3

winlinvip commented 2 years ago

@xiaosongxiaosong I just checked it out, it's great indeed, very suitable.

TRANS_BY_GPT3

xiaosongxiaosong commented 2 years ago

I took some time today to create a demo. I will work on the search and multiple languages this week. For the content of the documentation, I have randomly copied a few Chinese documents. Repository address: https://github.com/goblin-laboratory/srs-docs Preview address: https://goblin-laboratory.github.io/srs-docs/

TRANS_BY_GPT3

winlinvip commented 2 years ago

@xiaosongxiaosong Did you message me on WeChat? Let's chat, I want to reorganize the documents, we can work on the documents together.

TRANS_BY_GPT3

xiaosongxiaosong commented 2 years ago

I sent you a friend request, haha. I was a bit busy during the day today, so contact me after 6 pm when you are free, @winlinvip.

TRANS_BY_GPT3

winlinvip commented 2 years ago

Create a new repository https://github.com/ossrs/srs-docs and assign admin role to @xiaosongxiaosong , thanks a lot 👍

qingmang commented 2 years ago

Finally waiting for you

TRANS_BY_GPT3

yzm0080 commented 2 years ago

docsify is also a good choice

TRANS_BY_GPT3

winlinvip commented 2 years ago

We have already started the project, so there is no need for further discussion on the plan. Thank you all.

Those who want to participate can leave a message. It's not about which plan is excellent, but about coming together to work on it.

TRANS_BY_GPT3

winlinvip commented 2 years ago

New domain ossrs.io has been launched and overseas servers are now available. In the future, the default language for overseas will be English.

In China, ossrs.net still defaults to Chinese, and the servers are hosted on Alibaba Cloud.

The two domain names and servers are isolated, but they have the same content and are automatically deployed through CI/CD.

TRANS_BY_GPT3

zpczpc commented 2 years ago

Through the tutorial on the official website's wiki, after about a week of exploration, I successfully deployed a test environment for gb28181. The most amazing thing is that the source code is an all-in-one package, which can be built and used without downloading other dependencies. I give you a thumbs up and feel proud of our Chinese programmers for making such excellent open source projects. I hope you keep improving and fighting! I hope I can also contribute in the future.

Hello, sir. Can the use of this protocol enable the playback function for Hikvision cameras?

TRANS_BY_GPT3

jinchengcheng commented 2 years ago

I am in the Java direction and I want to participate in the project. However, it is difficult to transition between industries. I hope there can be easier-to-use APIs for beginners at the low level, while also supporting secondary development in Java. If this is possible, it would be great. It would allow people like me with different backgrounds to be able to work on streaming media-related things. Please don't take offense, just offering a suggestion.

TRANS_BY_GPT3

winlinvip commented 2 years ago

The new official website and documents have been launched:

Chinese: https://ossrs.net
International site: https://ossrs.io

The new official website is now open. We welcome everyone to continue participating.

https://github.com/ossrs/srs-docs

TRANS_BY_GPT3

ossrs / srs

Docs: Rewrite ossrs.net, rewriting official website documentation #2785