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

FAQ (frequently asked questions) documentation for extensions #42520

Merged
merged 2 commits into from
Oct 22, 2024

Conversation

holly-cummins
Copy link
Contributor

@holly-cummins holly-cummins commented Aug 13, 2024

Preview link: https://quarkus-pr-main-42520-preview.surge.sh/version/main/guides/extension-faq

This combines the

  • A list of FAQs
  • List of common extension tasks (dev service, rewrite byte code, etc) with links to a “how to”, indexed by the ‘problem being solved’ rather than the ’solution technology’

goals from #37288.

FAQ for the FAQ :) 



Uh, Holly, it doesn't build cleanly

It's waiting for #42446 to merge. If we think that PR will be a long time I'll remove the cross-references to un-block this PR, but they fit in quite nicely so it would be nice to not have to redo them. #42446 has not been merged yet, but references to #42446 have been removed, in the hopes of allowing forward progress.

Is this complete?

Goodness me, no! But has been open for ages, so I decided not to let perfect be the enemy of good. Once we have a FAQ, we can iterate.

Is the Diataxis type right?

I wondered about this too, and consulted with @ebullient. We decided that this document is a pointer to other how-tos, and it’s ok that it itself doesn’t fit exactly into one of the diataxis types.

Is the JobRunr link the right one?

I wasn’t sure whether to link to the JobRunr repo or the extensions page. Normally the extensions page would link to the repo, but for JobRunr it doesn’t. I’ve raised an issue to try and get that sorted out, so decided to go for the ‘long term best’ link.

Copy link

quarkus-bot bot commented Aug 13, 2024

Thanks for your pull request!

Your pull request does not follow our editorial rules. Could you have a look?

  • title should preferably start with an uppercase character (if it makes sense!)

This message is automatically generated by a bot.

@holly-cummins holly-cummins changed the title "Frequently asked questions" documentation for extensions FAQ (Frequently asked questions) documentation for extensions Aug 13, 2024
@holly-cummins holly-cummins changed the title FAQ (Frequently asked questions) documentation for extensions FAQ (frequently asked questions) documentation for extensions Aug 13, 2024

This comment has been minimized.

This comment has been minimized.

@holly-cummins
Copy link
Contributor Author

@maxandersen and @gsmet, do you have a sense whether this PR or #42446 is likely to merge first? I assumed when I did the cross-references that they'd merge in the order I submitted them – but if we think this is will merge before #42446 I'll remove the cross-reference so that this compiles cleanly and is merge-able without being blocked on #42446.

@holly-cummins
Copy link
Contributor Author

holly-cummins commented Oct 7, 2024

As there's no immediate prospect of #42446 merging, I don't think this PR should block on that content. I've removed The xref:extension-maturity-model[extension maturity model] shows the kinds of capabilities extensions can offer. from line 22, and changed 'Another useful thing' to 'One useful thing' on the following line.

There's also a whole section that I've removed:


## How do I know what kind of capabilities I might want to include in an extension?

Have a look at the xref:extension-maturity-model[extension maturity model].

This comment has been minimized.

Copy link

github-actions bot commented Oct 7, 2024

🙈 The PR is closed and the preview is expired.

This comment has been minimized.

Copy link
Contributor

@gastaldi gastaldi left a comment

Choose a reason for hiding this comment

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

LGTM

This comment has been minimized.

@holly-cummins
Copy link
Contributor Author

Hi @gsmet, is there something blocking the merge of this PR?

Copy link

quarkus-bot bot commented Oct 16, 2024

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 693ddaf.

✅ 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.

@gsmet gsmet merged commit 31142e2 into quarkusio:main Oct 22, 2024
5 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.17 - main milestone Oct 22, 2024
@gsmet gsmet modified the milestones: 3.17 - main, 3.16.0 Oct 23, 2024
@rsvoboda rsvoboda modified the milestones: 3.16.0, 3.15.2 Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

5 participants