-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
Conversation
Thanks for your pull request! Your pull request does not follow our editorial rules. Could you have a look?
This message is automatically generated by a bot. |
This comment has been minimized.
This comment has been minimized.
1ad7907
to
f269d02
Compare
This comment has been minimized.
This comment has been minimized.
@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. |
As there's no immediate prospect of #42446 merging, I don't think this PR should block on that content. I've removed There's also a whole section that I've removed:
|
cefbdd7
to
926f723
Compare
This comment has been minimized.
This comment has been minimized.
🙈 The PR is closed and the preview is expired. |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
a7b1fd9
to
9b63040
Compare
This comment has been minimized.
This comment has been minimized.
Hi @gsmet, is there something blocking the merge of this PR? |
Co-Authored-By: George Gastaldi <[email protected]>
9b63040
to
693ddaf
Compare
Status for workflow
|
Preview link: https://quarkus-pr-main-42520-preview.surge.sh/version/main/guides/extension-faq
This combines the
goals from #37288.
FAQ for the FAQ :)
Uh, Holly, it doesn't build cleanlyIt'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.