Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update FAQ with links to extensions.quarkus.io and syntax updates #2168

Merged
merged 1 commit into from
Dec 3, 2024

Conversation

holly-cummins
Copy link
Contributor

@holly-cummins holly-cummins commented Nov 18, 2024

I was trying to google for the maturity matrix, but it's not indexed yet. What google did send me to was the general FAQ, which has a line about how we have a maturity model, and no link. There couldn't be a link because the reference is several years old. I can't add a link until the matrix doc is in a 'latest' release, but while I was looking at the doc, I noticed a few other areas that could use some love.

There's a suggestion to use code.quarkus.io to check extension status, but extensions.quarkus.io is a more natural place to look up that kind of metadata. It also assumes no extensions live in the quarkiverse org, presumably because it was written before there was one.

The wording about stability is a bit weak, so I strengthened with a link to our user stories.

I also noticed the headings were markdown ones, so I swapped them to adoc style.

Finally, there was a link to the 'orginal' /extensions page, which now redirects to code.quarkus.io. For that link, code.quarkus.io is a much better destination, so I've replaced /extensions with code.quarkus.io.

Copy link

github-actions bot commented Nov 18, 2024

🙈 The PR is closed and the preview is expired.

@holly-cummins
Copy link
Contributor Author

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added some comments, the only one I really want addressed is to avoid the http link. For the rest, I let you judge of what is best.

faq.adoc Outdated Show resolved Hide resolved
faq.adoc Outdated
Comment on lines 18 to 20
Yes, we consider Quarkus stable.
Quarkus is used in production by a https://quarkus.io/blog/tag/user-story/[range of organisations].
Remember 95% of the features Quarkus apps use are provided by the ecosystem like Hibernate ORM, Eclipse Vert.x, Netty, RESTEasy, etc. These libraries are rock solid :)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about this content now tbh but probably not something to discuss in this PR.

I wonder if I would have wide range of organizations (see some link:user stories) because otherwise it's a bit limiting. But not really sure and also don't want to start a long discussion here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I decided to go for "make it better than it currently is" rather than "make it optimal". I agree a bigger rewrite is needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have strong feelings about either wording, so I've gone with your suggestion and squashed.

@holly-cummins
Copy link
Contributor Author

Could I nudge on this? I've got another change backed up behind it ...

…k to user stories, use adoc-style headings

Also replace link to old extensions page with a better link to code.quarkus.io

Co-Authored-By: Guillaume Smet <[email protected]>
@gsmet
Copy link
Member

gsmet commented Nov 27, 2024

Sorry, missed your ping, I fixed the conflict for you because the issue came from me lagging.

I'll merge once CI is green.

@holly-cummins
Copy link
Contributor Author

Thanks!

@maxandersen maxandersen merged commit 589570f into quarkusio:main Dec 3, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants