-
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
Panache docs should have a full REST resource before the advance query section #10927
Comments
/cc @FroMage, @loicmathieu |
I want to work on this ,I would be extremely thankful if someone could guide me on how to get started with this? |
@imshuv if you're new to contributing to Quarkus, you can read the Contributing for the first time blog post. |
Hi @loicmathieu If someone is not working on this issue can you please assign this to me. Many thanks! |
@imshuv you ask for advise on this one two weeks ago, do you plan to work on it ? Otherwise I'll assign it to @Anushka-shukla thats also volonteer for it. |
I wanted to work on it but being a beginner I'm not able to understand a lot of things. |
Fixes quarkusio#10927 (cherry picked from commit c3073c7)
Describe the bug
In reviewing the getting started docs for panache at (https://quarkus.io/guides/hibernate-orm-panache) there are a couple of common errors that users might make and some opportunities to reorder some of the sections for simpler getting started and new users.
H2 in mem url for simple getting started
The one thing that I would think about adding for getting started is a reference to a pure in memory h2 configuration so that somebody could get booted up in memory without having to leave the page. I had to google the jdbc url for h2 in memory
jdbc:h2:mem:testdb
Rest Resource example
we need to add an example for a REST resource before the advance query section.to provide full examples prior to the advance query section. Discussed with @loicmathieu in Zulip and we decided to open this ticket to track some potential updates.
Transactional Context
There was also some discussion around updating or linking to some additional context on when an
@Transactional
annotation is required. This is all covered in the docs already but may be worth additional info.From the chat:
Expected behavior
We need to add an example for a REST resource before the advance query section.
Actual behavior
See docs
To Reproduce
N/A
Configuration
N/A - Docs
Screenshots
NA
Environment (please complete the following information):
Output of
uname -a
orver
:Darwin Josephs-MBP.homenet.telecomitalia.it 18.6.0 Darwin Kernel Version 18.6.0: Thu Apr 25 23:16:27 PDT 2019; root:xnu-4903.261.4~2/RELEASE_X86_64 x86_64
Output of
java -version
:GraalVM version (if different from Java):
Quarkus version or git rev:
latest docs at
Build tool (ie. output of
mvnw --version
orgradlew --version
):Additional context
(Add any other context about the problem here.)
The text was updated successfully, but these errors were encountered: