Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Packit documentation (from non maintainers point of view) #2423

Open
2 tasks
majamassarini opened this issue May 9, 2024 · 1 comment
Open
2 tasks
Labels
area/fedora Related to Fedora ecosystem complexity/single-task Regular task, should be done within days. kind/documentation Documentation needs updates.

Comments

@majamassarini
Copy link
Member

A feedback from the First Workshop 2024 was:

My problem with Packit for a couple of weeks was: I couldn't understand
the concept in scenarios were I don't use the Packit Service in a GitHub
repo.

I don't know why it was so hard for me till I finally understood what
Packit can and can't do. I felt lost in the documentation, probably
because missing background.

After investing time to read about the different related services and
concepts. Actively getting involved in Fedora Packaging. Things became
more clear.

Even though our users are maintainers we have the feeling that new people are approaching Packit when they are still learning how to become a maintainer. For this reason we should improve our documentation from the point of view of non maintainers.

  • Since the Fedora ecosystem for maintainers is quite complex, provide in our documentation an overview for it. A diagram of all the involved services and also an explanation of the more important terms.

  • Link from our documentation the Fedora Maintainers Documentation resources where useful

@majamassarini majamassarini added the kind/documentation Documentation needs updates. label May 9, 2024
@nforro
Copy link
Member

nforro commented May 9, 2024

I would just add, even though we have improved the documentation a lot in that regard, when you look at the front page, it's really upstream focused. For example the Who should use Packit? section doesn't mention Fedora maintainers at all, the Automating Fedora Releases section is also written from a PoV of an upstream maintainer, the big Get Started button takes you to the upstream onboarding guide...

@mfocko mfocko added area/fedora Related to Fedora ecosystem complexity/single-task Regular task, should be done within days. labels May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/fedora Related to Fedora ecosystem complexity/single-task Regular task, should be done within days. kind/documentation Documentation needs updates.
Projects
Status: priority-backlog
Development

No branches or pull requests

3 participants