#3167 Improved documentation on koji hub/builders installation end-to-end from scratch
Opened by bukich. Modified

Hello Tomas, Ken, Koji Team,

First I want to apologize for my late issue. I and Tomas had a short e-mail discussion almost two months ago. Unfortunately, my work tasks are a never-ending game, but finally, I found some spare time to write my thoughts/ideas structured in a message.
My original idea is to become or at least to try to be a contributor to Koji's documentation project if possible of course.
My personal Fedora account is 'bukich'. Some time ago I created the following issue which was fixed so quickly, thanks :) - https://pagure.io/koji/issue/3025.
But first, let me introduce myself.
My name is Kostadin Bukov 41 years old Sagittarius from Bulgaria (EU country) and working at my home office as a full-time Solution Architect - Platform in the RnD department for a software company. I'm not a developer :) I have a decade+ of Linux (RHEL, Fedora, Debian) sysadmin background although from the last 5 years I'm mainly involved and focused on commercial proposals as a technical expert. For almost a year I'm working on the migration of our old koji instance (koji-1.14.0-52.el7.noarch on RHEL 7.4) to a new and modern Fedora 34 (koji-1.26). For the last few months I installed our new koji servers on fedora 34 with hardware - 2 x HP bl460c G9 blade server (one hub/web and one builder), latest koji version and still working on the migration from the old one. As an absolute beginner in Koji I started to document every single installation and configuration step that I did on the new koji (in markdown format). The reason was that the old koji instance had zero documentation and I wanted to 100% document our new koji installation and configuration to be easier for me and my colleagues and maybe for other people as well.
In the end, my internal koji installation guide document included quite a lot of steps which might be useful for somebody else like me who installed koji for the first time and had no idea what an adventure and fun is all that :)))
Your documentation in https://pagure.io/docs/koji/ is great and helped me a lot.
This is my first attempt to offer to contribute to an open-source project and I will be excited if I can help around even with a minor thing.
Something more about me, I like to listen to music, watch movies (mostly in Cinem), married guy with kids.
Sorry if my introduction was too long :)

My ideas below are just initial suggestions and I would be grateful if my issue trigger a wider Koji community discussion. I'm using the opportunity and for another reason - I'm following closely the mailing list discussion in 'koji-devel@lists.fedorahosted.org' - 'My woes with the current state of Koji'. Maybe my thought can help there as well.

Now my thoughts:
The idea is:
- to have end-to-end installation and configuration for all koji components (for me the native environment for such installation is Fedora, not CentOS or RHEL but I might be wrong :). Our current RHEL 7.4 koji installation causes some pain especially when new packages need to be installed..
- to start from the very beginning - OS installation and partition layout (maybe something like best practices or other)
- the document is intended to be 'absolute beginner' friendly and cover all steps of installation with example configuration which includes apache config as well.
- to have a section with basic troubleshooting steps (maybe) and how to verify each step of the installation
- how to install the components (for example all components on the same server or better on 2 servers (one with koji hub/web/apache, kojira and second just with koji builder (kojid))

Not sure if all of the above is for the https://docs.pagure.org/koji/server_howto/ section only so kindly can you share your point of view.
I saw that all current official Koji documentation is in .rst (reStructuredText format) but my current is in .md (markdown).

My next tasks are two :)
- first to figure out how to create a PR with my document(s) - (I cloned the official koji repo in my account bukich)
- update my internal document and make it more 'absolute beginner' friendly and post it for your review via a PR. I'm thinking also to convert it from .md to .rst format but maybe this would take me some more time. It seems that .rst in the future for such technical documentation.

Again sorry for my long long post, sure I missed a lot of things, but let's see how all this will be accepted or not :) from you and from the koji community and move forward.

Regards,
Kosta


Thanks for the work! I'm waiting for that PR :-)

Metadata Update from @tkopecek:
- Custom field Size adjusted to None

This issue has been migrated to Fedora Forge:
https://forge.fedoraproject.org/koji/koji/issues/3167

Please continue any further discussion there.

Metadata