Quarkiverse documentation

[Antonio Goncalves]

Hi all,

We are starting to implement a set of Quarkus extensions for Azure on Quarkiverse[1]. We are following the steps described in the Wiki[2], so far so good. What we don't know is how to create the documentation that goes with the extension. We have a couple of READMEs, but we alo found out that most of the extensions have a docs directory[3] with an antora.ynl file and a modules/ROOT directory.

Any pointers on how to help us setting up the documentation ?

Thanks

[1] https://github.com/quarkiverse/quarkus-azure-services

[2] https://github.com/quarkiverse/quarkiverse/wiki

[3] https://github.com/quarkiverse/quarkus-google-cloud-services/tree/main/docs 

--

Antonio Goncalves 
Java Champion

Blog | Twitter | LinkedIn | Author | Pluralsight | Devoxx France | Voxxed Microservices

[Guillaume Smet]

Hi Antonio,

My recommendation is to initialize your extension using the process documented here: https://quarkus.io/guides/writing-extensions#create-new-quarkus-core-extension-modules-using-maven

Make sure you use your Quarkiverse groupId. This will initialize everything that is needed for the Quarkiverse infrastructure (docs repo, CI workflows...).

Given you already have stuff in your extension, I would either create the extension and copy your stuff in it or do the opposite (don't forget the hidden .github directory).

The Quarkus GitHub App extension is a good example of how things should be set up: https://github.com/quarkiverse/quarkus-github-app/tree/main/docs .

Once you have all that done, you can include your extension here: https://github.com/quarkiverse/quarkiverse-docs/blob/main/antora-playbook.yml .

Feel free to ping me on Zulip if you need help, we can do a call.

--

Guillaume

--
You received this message because you are subscribed to the Google Groups "Quarkus Development mailing list" group.
To unsubscribe from this group and stop receiving emails from it, send an email to quarkus-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/quarkus-dev/CAKawoOZrLmMd3stCBZUoBRGt2odCokndR-wVKhuQ2ioWpGcTWA%40mail.gmail.com.

[Antonio Goncalves]

Thanks.

I've initialized a brand new extension and copied the missing parts (mostly workflow and docs). I've also added the doc to the Antory playbook

Thanks

Antonio

To view this discussion on the web visit https://groups.google.com/d/msgid/quarkus-dev/CALt0%2Bo8tyHezwjTxKJFp8Ecv-KnUykuNynRH2c0LT-Xi0z596A%40mail.gmail.com.

--

Antonio Goncalves 
Contractor, Java Champion and Pluralsight author