#74 use more real-world examples
Closed 2 years ago by ppisar. Opened 3 years ago by ktdreyer.

Would you please update the modularity documentation examples with many more real-world examples?

"nodejs" is everywhere, but the average Fedora packager will not be packaging nodejs.

Would you please remove the "lorem ipsum dolor sit amet" text from https://docs.fedoraproject.org/en-US/modularity/making-modules/defining-modules/ and use a real quality module here?

Which module in Fedora today is the best example of modularity? That would be a good one to use in the docs.

When you use real-world examples of real packages and modules, then new packagers will be able to easily understand what they need to copy+paste+change. Modularity will feel more concrete and less aspirational.


The docs also mention "calc" as an example. Does the calc maintainer really provide "calc" in a module?

Hi Ken, thanks for reporting the problem.
@mcurlej is currently reviewing modularity documentation and we're also evaluating responses from the survey we sent to fedora devel mailing list. Then we're going to move all documents in one place and fix as many issues as possible including this one.

I would like to see clear documentation on the correct minimal steps for requesting an additional module stream.

https://pagure.io/fedora-docs/modularity/blob/master/f/modules/ROOT/pages/making-modules/adding-new-modules.adoc only really covers adding a new module clearly.

For an existing module and package:

Does fedpkg request-branch --repo=NAME --sl rawhide:2020-12-01 -- BRANCH on the package also create the branch in the module namespace? -- Edit it does but it also requests the new module again....

Or should one use --no-automodule and run fedpkg request-branch --namespace modules --repo NAME BRANCH separately.

Apparently the answer is the latter: https://pagure.io/releng/fedora-scm-requests/issue/25297

ktdreyer, we cannot use real-world modules because they barely use all the features we need to cover in our documentation. perl-* modules were the state-of-art modules. But because I do not maintain them anymore, I cannot speak for their quality. I removed the "lorem ipsum" text from the examples.

I believe all the issues we can address have already been addressed.

Metadata Update from @ppisar:
- Issue status updated to: Closed (was: Open)

2 years ago

Login to comment on this ticket.

Metadata