This exchange was a great textbook example of @k_joseph asking a complicated question that requires some debugging in a specific environment, and @dkayiwa pushing him to document how to reproduce the error.
I think this would have worked even better if @k_joseph had known to define a Distro for the SDK, i.e. in a couple files he could specify OpenMRS core version, module versions, and SQL to run.
Basically, the Distro feature of the SDK is incredibly powerful and useful, but the documentation is too dense and opaque (there isnât even a direct URL to the Distro section of the SDK docs) so most OpenMRS developers donât realize how great it can be.
Some examples to follow of what this might look like are step by step tutorials I wrote for UI Framework and App Framework, and of course you can find plentiful tutorials on the web for other things.
Thanks for doing this @gutkowski! Your turnaround is much faster than my ability to review.
Reading through this, I think youâre focusing too much of how, instead of why. Focusing on the Setting Up Dev Environment section:
I would title the section âUsing the SDK to Contribute to an existing OpenMRS moduleâ
Describe the scenario why someone might want to contribute to a module (e.g. they are working on a ticket and they want to add a feature)
Give the big picture of what they need to do: set up a server, check out the module code, make changes (with TDD!), deploy them to the server, and run it
@darius thank you for feedback! Probably you are right, that we should include more âbig pictureâ. I will introduce the changes you requested in the coming days
I heard in the past there are many volunteers interested in working on documentation. Maybe we could get their help here as every feature is pretty much documented and we just lack proper structure and flow.
Thereâs value in having tutorials/screencasts done by someone who isnât on the dev team of the SDK, i.e. someone who wonât be tempted to go deep into the weeds of the SDK, but instead just show how to use it at a high level for common tasks.
Is there someone whoâs interested in improving the onboarding experience who might want to do this? @dkayiwa, @teleivo?
I can help putting together a tutorial based on the most common workflows that I use - probably early next week as I am currently swamped putting together a release this week. This can provide a foundation for adding more work flows
@dkayiwa I think I will need your help in this .
coz am realizing that I gat a poor insight in documentationâŠ
And tell me the tools needed coz am having only eclipse installed on my PCâŠ
man am still on the Newbie case but my first confusion is in the
UI FRAMEWORK STEP BY STEP TUTORIALS⊠where by this guy was using some
other programming language⊠which I donât understand but thats no big
dealâŠ
Next> in that UI FRAMEWORK STEP BY STEP TUTORIAL, that guy was
demostrating how one creates a page but my greatest bottle neck is with
the mix up of differ languages java and some other language!!
Is that the way we you guys do things OR???
And my other great interest is with creating a module, man am having a poor
insight on that⊠but I wana get started on itâŠ
PLEASE HELP ME OUT!!!