On Tue, Oct 20, 2015 at 2:47 PM, Mike McLean <mikem(a)redhat.com> wrote:
On 10/20/2015 11:47 AM, Adam Miller wrote:
> Hello all,
> I wanted to make a few suggestions/proposals to the Koji project
> to get feedback.
>
> First off, I'd like to propose that koji officially move out of
> FedoraHosted and into pagure[0] so that people can easily fork, create
> topic branches and open pull requests for interactive peer review.
This has come up separately, and think I am agreeable, but still just
slightly cautious to embrace a tool that is so recently out of beta.
There's also the question of pagure vs github. Some would argue that the
benefits you list are even more pronounced on github.
I don't have a hard preference. I generally default to suggesting
pagure.io when it comes to things that are within the Fedora ecosystem
but I have no qualms with github personally.
> In the event that is acceptable I would also like to propose that all
> documentation move out of the Fedora Wiki and move into the koji git
> repo itself under the docs directory either formatted as Sphinx[1]
> reStructured Text, or markdown[2]. This could either be hosted
> directly in pagure.io or in readthedocs.org[3].
Fixing docs is definitely a goal. Both pagure and github seem to have
separate docs features and I'm not sure what the best approach is.
readthedocs.org is popular both in the Fedora dev community and the
python community at large so if we went that route we could decouple
it from github or pagure.
I appreciate a nice web view for docs, but I also want the docs to
be
usable from just a checkout.
+1 - This is definitely something that I'd like. I think well
formatted/written Markdown or reStructured Text is readable/usable on
it's own but I'm open to suggestion, was mostly just wanting to point
out suggestions that are popular in the python ecosystem.
> From there I would like to suggest a formal website for koji, maybe
> koji.io or similar. I don't really have a preference or suggestion on
> the specific url. This website would be a simple landing page for all
> information that someone interested in Koji would be looking for. It
> would briefly explain what koji is, provide references on how to use
> it, deploy it, how to administer it, and how get involved in
> development of it. My idea is that the website itself would be a
> static site that is generated using something like pelican[4] or
> nikola[5], the source code for the site would also live in koji's git
> repository such that all content would be in a central location and
> could even be shared between the site and docs where appropriate. We
> could later get clever and have the website be updated automatically
> when a pull request gets merged that updates it's content, but I don't
> want to get ahead of myself.
Agreed. I would like to have a project website.
> In the event that is acceptable, I would also like to propose a
> "recommended developer workflow" and introduce the use of the tito[6]
> utility for koji to assist in both the release tasks but also for
> iterative development and/or eventual CI without giving up the
> standard rpm install process. I have started mocking up what I think
> would be a good starting place for a workflow, it's currently a work
> in progress and doesn't actually function as described for reasons I
> don't yet know (koji-hub and I are fighting with the database) but
> before chewing up more time working on it I wanted to make sure that
> this is even something that the group at large is open to.
tito seems to be a popular tool that solves a real problem. I haven't
really had the chance to use it much, though.
Overall I'm a tito fan, but I'm not married to it as part of the
proposal if there are reservations or alternatives that others prefer.
>
https://github.com/maxamillion/koji-dev
Thanks for the mock up
> Eventually if this developer workflow (or really any documented
> developer workflow) was deemed as "recommended" by the group, I would
> like to also have it live within the koji git repository such that it
> can be a part of the official documentation for new and potential
> contributors on how to get started working with koji development and
> be highlighted on the (new) proposed website.
Seems that that will fall in with docs, whether that ends up in the main
repository, or a separate git repository.
+1
Thanks,
-AdamM
> This is effectively a multi-part "step 1", as I would like to build on
> top of this and move towards having CI for the project but getting
> things in a place where we can easily facilitate iterative developer
> workflows is something that I consider as a prerequisite.
>
> I'm definitely looking forward to feedback, thanks for reading this far :)
>
> -AdamM
>
> [0] -
https://pagure.io/
> [1] -
http://sphinx-doc.org/
> [2] -
https://en.wikipedia.org/wiki/Markdown
> [3] -
https://readthedocs.org/
> [4] -
http://blog.getpelican.com/
> [5] -
https://getnikola.com/
> [6] -
https://github.com/dgoodwin/tito
> _______________________________________________
> koji-devel mailing list
> koji-devel(a)lists.fedorahosted.org
>
https://lists.fedorahosted.org/mailman/listinfo/koji-devel
>
_______________________________________________
koji-devel mailing list
koji-devel(a)lists.fedorahosted.org
https://lists.fedorahosted.org/mailman/listinfo/koji-devel