Restructuring and some kind of rework of the whole documentation

[codiflow]

I really love OCS Inventory and use this tools for years now (precisely ~6 years). Unfortunately the documentation always confused me and was not always helpful. It took me a lot of time to really get the piece of information out I was looking for.

I want to help changing that, so this is what this issue is about 🥳

The main cause I identified was because it is mixing up outdated information, old screenshots and also brand new information. Also the sorting on the left hand side in the menu is not intuitive (options like "Prerequisites" and "Introduction" are positioned at the bottom instead of at the top):

I really like the new documentation of BigBlueButton. They recently restructured everything and are using Docusaurus now. You can switch version in the upper right corner to always get the information relevant for your configuration.

Please get me right: I don't want to replace the current system. This was just an idea for the mid-term if we need to reflect old documentation for old versions as well. For now I would appreciate to just put the old information in some kind of "old" section and put all fresh and relevant content to the top. So if someone reads through the documentation it is always relevant for him/her.

I would also recommend to use English as the main language only. Just pointing that out because some graphics are using french terms which are somehow confusing too.

What are the benefits for everyone?
The documentation looks well maintained to newbies and oldies and always reflects the current state while being helpful and informative at the same time.

What are my benefits of this contribution?
I would get a deep dive into the structure and functionality of OCS Inventory. I really like to structure stuff and bring in my knowledge regarding this field. I'm familiar with writing documentation and contributing to open source projects.

Really love to get some input from you what you need here and how you think about this whole topic.

Thanks,
Christian

[gillesdubois]

Hello @codiflow

Thanks for your feedback ! (and sorry for the late rely)
I'm happy to know you are a long time user of OCS Inventory :)

I can only agree with you on the fact that the documentation is a bit messy.
The main problem is that we kept building our documentation on "legacy" base that were not correctly writted / positioned on the wiki. Most of the mess you are seeing right now is due to that.

We are currently working on a new version of OCS, the 3.0 (branches to be available soon).
I think that will be the right time to rethink correctly the documentation and make sure its crystal clear for everyone.

I'll make sure to mention you when we have a documentation rework going on :)

PS : As a bigbluebutton user myself, I agree with you their documentation is really good !

Regards,
Gilles DUBOIS.

[codiflow]

Hey @gillesdubois ,

thanks for the feedback. Great so I will wait until I get a ping from you 😎

I'm already waiting curiously for the 3.0 release 🥳

Thanks,
Christian

[haroon7v]

Hello! I just want to highlight same issue for compilation docs. I was following the docs, but got into a lot of issues while compiling external dependencies for Windows. For example, the docs says openssl-1.0.2r or higher, so I tried the latest version. In the external dependencies script, it was trying to use ms\do_win64a, which is not present anymore in current versions. In fact, if we try to use any dependency of higher version than the one mentioned as least version, compilation fails.
Also, I think that there should be some common errors troubleshooting sections, like the one I'm facing is

NTServicemg.msc exited with code 3.

But I was unable to resolve this. Also the mentioned least versions of dependencies are not even present on official sites, that are causing a lot of trouble for a new person like me. Would highly appreciate your response on this. Thank you!