Contribution Guidelines and Resources

[ghost]

These are some Contribution Guidelines and Resources I am writing so future contributors can better understand the scope and structure of the documentation.

Note that suggestions can be discussed and changes can be made to these guidelines accordingly.

Layout

The documentation has 2 versions, Bangla and English, so far the effort is focused on the Bangla documentation.
The documentation is divided into multiple sections.

-> Install instructions
---> finding-need (Contains non-OBK docs)
---> Distro-specific setup (How to setup OBK and it's related components for specific distros, workaround etc)
---> DE-specific setup (How to setup OBK and it's related components for specific DEs, workaround etc)
-> Build instructions

Note that generic instructions that can apply to many distributions at once should be kept at distro-setup.md, but there can be exceptions.

Scope

The scope of the documentation is limited to being an useful resource related to configuring OBK, primarily aimed towards new users.
It is not intended to be a guide for learning linux, or any linux distro-specific knowledge in general. Thus discussing topics outside of OBK and things necessary for OBK like ibus/fcitx should be kept as minimal as possible.

However, as the installation and configuration of OBK relies on various factors such as distro name/version and/or DE name/version, there is a need for atleast some introductory knowledge outside the scope of OBK docs, they have been documented in the finding-needs.md file.

Contributors are encouraged to contribute non-distro specific, generic documentation in the finding-needs.md file.

[ghost]

Also, based on the memories of my own experience as a novice linux user, observation of issues posted in the github issue tracker of OBK and various Bangladeshi linux social media groups online, my opinions is that,
Most Bangla-speaking linux users who want to use OBK are already tech-saavy/enthusiasts who have good knowledge of technology in general, but not of linux.

This is why I believe the focus of the docs should be more towards explaining linux-specific things related to installing/configuring OBK, like what ibus/fcitx are, how to check if they work properly etc.

But most users should already have enough/basic knowledge of their own OS, like how to run commands in a terminal, what package managers, or atleast package files like .deb/.rpm are etc. Explaining things like these are redundant.