quarkus-workshops icon indicating copy to clipboard operation
quarkus-workshops copied to clipboard

Refactor (and rename) to make this repository specific to the superheroes workshop

Open holly-cummins opened this issue 1 year ago • 7 comments

With the creation of https://github.com/quarkusio/quarkus-langchain4j-workshop, we are moving away from a mono-repo for the quarkus workshops. We should

  • Rename this repository to be specific for the superheroes workshop
  • Remove the 'hosts multiple workshops' text in the readme, and also the CI and front-end structures

We should then try and make a new github pages repo/site at https://quarkus.io/quarkus-workshops/ which indexes all of the available workshops, with links.

holly-cummins avatar Jun 20 '24 08:06 holly-cummins

@emmanuelbernard proposes:

"Let's define a convention (and ADRize it).

Context We get workshop like mushrooms during autumn season. It would be good to organise to facilitate new workshop creations and allow users to find them easily

Decision Quarkus workshops are hosted on https://github.com/quarkusio/ Each in their own repo The repo name has the following structure: quarkus-workshop-[theme] because it makes them easily findable by search AND by lexical order.

Optional: we create a quarkus.io/workshops landing page that can list the repos and extract the summary from the readme or something like that."

holly-cummins avatar Oct 17 '24 11:10 holly-cummins

What would theme be ? The main technology used ? The topic it covers ? The name of the workshop ? It we take the existing workshops, will would have:

  • quarkus-workshop-langchain4j: pretty vague because there are so many things that can be covered by langchain4j
  • quarkus-workshop-super-heroes: the name does not ring any technological bell

agoncal avatar Oct 17 '24 11:10 agoncal

theme is not the best word but enough of a unique qualifier that explains what it does. So for better of worse, quarkus-workshop-super-heroes sounds good because that's what it is known for now to the world. For langchain4j, I can imagine we end up with 2 or 3, in which case we need to help differentiate them. But I imagine the first come will do the best name squatting.

Not sure how much more rules to add to improve vs making it too complex.

Some random examples:

quarkus-workshop-super-heroes (or quarkus-workshop-overview) quarkus-workshop-openshift quarkus-workshop-langchain4j-concepts quarkus-workshop-langchain4j-in-app

emmanuelbernard avatar Oct 17 '24 12:10 emmanuelbernard

I would use quarkus-workshop-super-heroes as it has been branded like this for years. It's the Quarkus "petclinic" (without the pets... and the clinic).

cescoffier avatar Oct 21 '24 06:10 cescoffier

Hey, I wrote an ADR about the proposal https://github.com/quarkusio/quarkus/pull/44351. Please comment.

cescoffier avatar Nov 06 '24 15:11 cescoffier

I would use quarkus-workshop-super-heroes as it has been branded like this for years. It's the Quarkus "petclinic" (without the pets... and the clinic).

And still different from the Quarkus Superheroes Sample, which is really more the Quarkus "petclinic" (without the pets...and the clinic...).

edeandrea avatar Nov 06 '24 16:11 edeandrea

Just merged quarkusio/quarkus#44351 - so we can proceed:

  • [X] Each workshop will be hosted in its own repository.

  • [ ] Naming convention: Each workshop repository should follow the format quarkus-workshop-<topic>

  • [X] Documentation should be hosted with GitHub Pages in each repository, making each workshop more accessible.

  • [x] Each workshop repository should have the workshop topic to facilitate discoverability.

  • [ ] We will keep https://quarkus.io/quarkus-workshops/ as a landing page, which people can use to find workshops. In order to preserve the GitHub history, the quarkus-workshops repository should be renamed to https://quarkus.io/quarkus-workshop-superheroes, and then a new repository should be created, using the old name, quarkus-workshops.

    1. [ ] Rename repository to https://quarkus.io/quarkus-workshop-superheroes
    2. [ ] Create new quarkus-workshops repository
    3. [ ] Setup a landing page using Jekkyl, this page could discovery the other workshops by looking for the other repository using the workshop topic
  • [ ] This landing repository can also be used to host redirects. For example, the existing URL https://quarkus.io/quarkus-workshops/super-heroes/ should be kept valid by using a redirect.

cescoffier avatar Nov 11 '24 08:11 cescoffier