[keycloak-dev] Community extensions and examples

[Stian Thorgersen]

Broken examples have nothing to do with where they are. It's down to lack
of automated tests. The examples in the same repo have been broken
countless amount of times in the past and we used to manually test it. The
new quickstarts have full automated testing and as part of a release we are
setting up CI jobs that check the quickstarts against the latests Keycloak.

Examples should not be tied to a specific API we need to be backwards
compatible. In fact moving to a separate repo makes it more obvious when we
break API compatibility. That might be awkward for us, but it's a good
thing for our users.

Whether or not users find them or not has also nothing to do with them
being in the same repo. There's a download for the examples of the website
and it doesn't matter what repository that comes from.

We also where required to have quickstarts in a separate repo for product.
So we would have had to have separate examples for Keycloak and RH-SSO if
they where going to be in the same repo.

That's a completely different thing to what this discussion was about
though. This discussion was purely about extensions and examples that we
are not able to maintain so we can't accept them to the main repo.

On 29 June 2017 at 23:50, Bill Burke <bburke at redhat.com> wrote:

> One more thing:
>
> Broken examples are akin to documentation that is incorrect.   It pisses
> people off and makes Keycloak look bad.  Moving examples to a different
> repo that is only maintained by community won't get maintained.  That's
> a fact.
>
>
> On 6/29/17 5:45 PM, Bill Burke wrote:
> > -1000. But you've already done this with the quickstarts against my
> > wishes.  You know why, but I'll rehash anyways:
> >
> > * Examples will get out of sync
> >
> > * Examples will end up not working
> >
> > * Examples need to be tied to a specific release as APIs and SPIs change
> >
> > * Users won't know they exist
> >
> > * Examples won't pick up IDE refactorings of our SPIs and APIs because
> > people will forget to include them.
> >
> > There's really no good reason to have quickstarts and examples in a
> > separate repo and a separate build other than "Wildlfy does it."
> >
> >
> > On 6/29/17 5:44 AM, Bruno Oliveira wrote:
> >> +1 that would be great
> >>
> >> On 2017-06-28, Stian Thorgersen wrote:
> >>> At times there are extensions and examples that we don't want to
> >>> include in
> >>> the main repository. This could be for several reasons, including:
> >>>
> >>> * We don't have the resources to maintain and support it
> >>> * We don't believe it's generic enough
> >>> * Examples that are to complex
> >>>
> >>> However, these can still be useful for some people. So I'm thinking
> >>> about
> >>> how we can provide community maintained extensions and examples.
> >>>
> >>> A very simple idea would be to add a page on our website that links
> >>> to the
> >>> relevant repository and documentation. To contribute you would setup
> >>> your
> >>> own Github repository, documentation and also a download if you
> >>> want. Then
> >>> you'd send a PR to the website to add your extension or example.
> >>>
> >>> Thoughts?
> >>> _______________________________________________
> >>> keycloak-dev mailing list
> >>> keycloak-dev at lists.jboss.org
> >>> https://lists.jboss.org/mailman/listinfo/keycloak-dev
> >> --
> >>
> >> abstractj
> >> _______________________________________________
> >> keycloak-dev mailing list
> >> keycloak-dev at lists.jboss.org
> >> https://lists.jboss.org/mailman/listinfo/keycloak-dev
> >
>
> _______________________________________________
> keycloak-dev mailing list
> keycloak-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/keycloak-dev
>