-
Notifications
You must be signed in to change notification settings - Fork 185
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
missing steps in documentation #64
Comments
Some items may be missing due to the code base evolving, so yes please propose changes. Sometimes a note/reminder is enough, sometimes text should be added. |
Thanks @jponge - i'll use my judgement and make the changes I think match the circumstance. This week is pretty busy for me, so it will probably only be toward the end of next week or the week after. |
Sure, take your time!
…On Mon, Sep 2, 2019 at 2:45 PM Andrew Gates ***@***.***> wrote:
Thanks @jponge <https://github.com/jponge> - i'll use my judgement and
make the changes it think match the circumstance. This week is pretty busy
for me, so it will probably only be toward the end of next week or the week
after.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#64?email_source=notifications&email_token=AAAGK2IF5DO7UH22FDMQNC3QHUDEZA5CNFSM4ISTPQF2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD5VXCCY#issuecomment-527134987>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAAGK2OXWEB3WYEHRKPZTN3QHUDEZANCNFSM4ISTPQFQ>
.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I've opened this issue to see if there is something i can help with.
So far while working through the guide i've noticed small steps have been omitted (noticeably from step 5 onward).
My question is if this is intentional - i.e. left to the reader as an exercise, omitted to save space, or if its just a small oversight?
For example:
SqlQueries
enumeration and the database verticleloadSqlQueries
method.apiGetPage
method requires a new database service methodfetchPageById
that is not mentioned at all (along with the corresponding changes to thedb-queries.properties
file,SqlQueries
enum etc)Hopefully by this point in the tutorial the reader should be reasonably comfortable making the necessary changes without being show explicitly, so perhaps all that is required is a tip / note to remind the reader to make the changes on their own, rather than discovering something is missing when their IDE complains?
I'm happy to help out with some changes if you like - just let me know what sort of style to follow - full step-by-step instructions or just a reminder.
The text was updated successfully, but these errors were encountered: