Propositions to improve the documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Dear All,
I joined the packaging team recently, or should I say I joined the mailing list, since for the rest I am still looking for a sponsor and all that ... anyway I want to share few ideas with you ... In my first messages I highlighted that the documentation might need some updates / improvements,
for the newbie that I am parts of it were / are still confusing.
Otto Liljalaasko offered me to suggest modifications in the doc ... here I go ... again keep in mind
that I am new to all this ;-)

About "https://docs.fedoraproject.org/en-US/package-maintainers/Using_the_Koji_Build_System/";

This doc, talks about "Koji" build,  however the first command lines on that page that introduces "Koji" referred to "fedpkg" and the relationship between both are somewhat unclear, a diagram would really help. I could try to make one but again considering that I do not understand thing properly I would likely mess it up. If I understand the doc properly the paragraph "Building with fedpkg targets" should not be located at the beginning (that confused me really) but latter on introducing a somewhat simpler, easier way to use "Koji" ... or if I tackle this in the wrong direction then the page should be renamed "Using fedpkg to build RPMs" and could provide extra information to understand that "Koji" is actually the command that works in the background
and how to use "Koji".

About "https://docs.fedoraproject.org/en-US/packaging-guidelines/";

I am still walking through this big doc, but my first comment is that it does not point towards practical example(s), why not add a link to  "https://src.fedoraproject.org/"; (that was pointed out to me by  Alexander Ploumistos, thanks again)
that would really help, to understand how things are done.
Or maybe even better a basic, yet complete example, to build a RPM for Fedora, some kind of a simple template to follow to do things properly. Beginning with the easiest, most simple example, yet complete, and the rest of the doc would detail modifications that can be made to this example for advanced/app/package/Fedora ... specific requirements. With the actual format of the doc, and if you have no idea how to build a spec file, well I simply think that you cannot do it, also because tt seems to me that several commands that are required for a proper spec file to work are simply not introduced:

-Group:, ex: Group: Productivity/Scientific/Physics
Not even sure that this is required, but you can find it in many spec file, if required this should be introduced,
as well as the different groups available if Fedora.

-License:, ex License: AGPL-3.0-or-later (not even sure what keyword to put here) Not even sure that this is required, but you can find it in many spec file, if required this should be introduced,
as well as the different keywoards to be used for packaging for Fedora.

- %autosetup and %setup: in the doc %autosetup refers to %setup + patch, %setup is not introduced, basically I know that it must be used  but I have no idea what it does ... what are the normal setup task ?

Sure I could keep going, now with the example I think should be provided, then it will be mandatory to introduce any required commands so that beginners could understand what is going on, and when you are a newbie,
this simple basic help really does matter.
Now if such an example is somehow provided already, well, I, all newbie that I am, missed it, and that might be an issue
because I was really looking for it.
Again these are just ideas, and I have knowledge to build this clean / simple / complete example ;-)

If anything else comes to mind while I study how to prepare and maintained RPMs I will let you know.

On another note, I want to thank you all for the warm welcome I received when I joined the list, this really was nice, I had a somewhat bad experience few years ago in an other open source community and was not sure what to expect here ...  well the feeling is really nice, thank you !

Hope this helps.
Best regards.

Sébastien

--
===========================================================
Dr. Sébastien Le Roux
Ingénieur de Recherche CNRS
Institut de Physique et Chimie des Matériaux de Strasbourg
Département des Matériaux Organiques
23, rue du Loess
BP 43
F-67034 Strasbourg Cedex 2, France
E-mail: sebastien.leroux@xxxxxxxxxxxxxxxx
Webpage: https://www.ipcms.fr/sebastien-le-roux/
ATOMES project: https://atomes.ipcms.fr/
RINGS project: http://rings-code.sourceforge.net/
ISAACS project: http://isaacs.sourceforge.net/
Fax:   +33 3 88 10 72 46
Phone: +33 3 88 10 71 58
===========================================================
_______________________________________________
devel mailing list -- devel@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to devel-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/devel@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue




[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Index of Archives]     [Fedora Announce]     [Fedora Users]     [Fedora Kernel]     [Fedora Testing]     [Fedora Formulas]     [Fedora PHP Devel]     [Kernel Development]     [Fedora Legacy]     [Fedora Maintainers]     [Fedora Desktop]     [PAM]     [Red Hat Development]     [Gimp]     [Yosemite News]

  Powered by Linux