quarkus
quarkus copied to clipboard
quarkusio
Add explanation/concept for extension maturity model
This is part of the bigger plan for extension documentation: https://github.com/quarkusio/quarkus/issues/37288
Obviously, there’s a gap for dev services documentation, which I’ll move on to next. Once I've got something linkable for dev services documentation, I will come back and link here.
One of the links needs https://github.com/quarkiverse/quarkiverse/pull/229 to merge for it to resolve. I decided to be optimistic about the order things would happen and put the link in anyway.
The preview comments aren't working, but this is the link to the new page: https://quarkus-pr-main-42446-preview.surge.sh/version/main/guides/extension-maturity-model
Question for reviewers: Should the list at the top be numbered? Or perhaps a graphic, so that it's more distinct from the table of contents lower down? https://en.m.wikipedia.org/wiki/File:Characteristics_of_Capability_Maturity_Model.svg is a somewhat standardised visualisation of maturity models, but it's harder to edit than raw text.
Status for workflow Quarkus CI
This is the status report for running Quarkus CI on commit 16e3f8e68b01c5919e0231c1cd33a9d891f3b0f8.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
[!WARNING] There are other workflow runs running, you probably need to wait for their status before merging.
You can consult the Develocity build scans.
![quarkus-bot[bot] avatar](https://avatars.githubusercontent.com/in/90234?v=4 "Published by a pub.dev verified publisher"){kind=small}
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit 16e3f8e68b01c5919e0231c1cd33a9d891f3b0f8.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit 9c136183bdda101defa6b6ef1c1c94bfdb84ecd8.
Failing Jobs
:warning: Artifacts of the workflow run were not available thus the report misses some details.
| Status | Name | Step | Failures | Logs | Raw logs | Build scan |
|---|---|---|---|---|---|---|
| ✖ | Documentation Build | Build |
:warning: Check → | Logs | Raw logs | :construction: |
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit 586b196694b80e29d0ce4be66a61fc060eb34542.
Failing Jobs
:warning: Artifacts of the workflow run were not available thus the report misses some details.
| Status | Name | Step | Failures | Logs | Raw logs | Build scan |
|---|---|---|---|---|---|---|
| ✖ | Documentation Build | Build |
:warning: Check → | Logs | Raw logs | :construction: |
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit 426380deacbd69ffac2f09c7b829508a90de2802.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit cc470d6d3004941ec85f7f00f5830695b5a24b5f.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit 11153d45b225ef0f53f960a92d671dd56c08b948.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
I’ve changed the list to a graphic. This has the benefit of adding something beyond what’s in the ToC below and the base writing-extensions guide. It has the disadvantage it’s hard to maintain. I don’t have the tools to do it, but @insectengine might be able to convert it to an svg, which would still render nicely, but would have a slightly higher bus number than my png.
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit ae075f751b99a30889df365acec89b4102ff4e17.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit 10b390141607895ad92097c5ae6b170b56f4694c.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
Created a slightly different view of the graphic (PNG and .SVG)
Thanks! Visually, that looks way better than mine, but I'm not sure about the shape. I think people's expectations of a maturity model would be a bit more stair-case-y. There's some variation in what google shows, including one pyramid, but almost all of them have a linear progression from bottom to top and left to right:
I had in mind something like this:
Because we have more stages than that example it does make it harder to fit everything on the page, but I think it does make it easier to understand the intent.
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit 697348542747350b8fe205ff6e60aa22448fcc4c.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
Ah ok, my mistake. How about this version 2?
I made updates to the PR, but forgot to comment. That looks super, @insectengine. Thanks! (It can be seen on the preview at https://quarkus-pr-main-42446-preview.surge.sh/version/main/guides/extension-maturity-model.)
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit 55293dc197f749953cdd8fb3daf21e613269b838.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
@insectengine, I've just noticed that CodeStart is camel-cased in the diagram, but it should be Codestart. I've fixed it in the svg (the joy of svgs), but you might want to update your local copy.
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit 5fe66a8941aa5bcefbe5f6eb632675668dba77c7.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.
Hi @maxandersen and @gsmet, is there anything I can do to get this moving?
@maxandersen and @gsmet, I'd like to be able to refer people to this material. Can you please advise if my best option is take this content and host it elsewhere?
@maxandersen and @gsmet, I'd like to be able to refer people to this material. Can you please advise if my best option is take this content and host it elsewhere?
sorry - missed it during travel/sick.
Ineed to refresh my memory - i'll make sure to have re-read it by time we meet at devoxx next week :)
@melloware, I liked your reference to "quarkusifying projects" the other day. It made me realise there's some overlap with what this work item is trying to describe. As our most prolific creator and maturer of new projects, do you mind casting your eye over this? The preview link is https://quarkus-pr-main-42446-preview.surge.sh/version/main/guides/extension-maturity-model?
@holly-cummins looks great. The only feedback i have when I have been Quarkiversifying extensions and helping others fix theirs is there doesn't seem anywhere there is enough emphasis on making sure the quarkus-extension.yml has the right information, category, icon URL, config, etc. I always look at that first when updating or fixing an extension. Other than that this is great!
Thanks, @melloware! I have plans (someday) for more automated validation of the quarkus-extension.yaml, but that would only partially cover the things people do now. I've added an extra line into the introduction pointing people to that file and explaining that it's important.
:waning_crescent_moon: This workflow status is outdated as a new workflow run has been triggered.
Status for workflow Quarkus Documentation CI
This is the status report for running Quarkus Documentation CI on commit b8a74ead28c447b8aaccdf62f91dffc45f50c17b.
:white_check_mark: The latest workflow run for the pull request has completed successfully.
It should be safe to merge provided you have a look at the other checks in the summary.